RemotePeer class

Inheritance

Constructors

RemotePeer({required String peerId, String? metadata, String? role})

Properties

hashCode → int
The hash code for this object.
no setterinherited
labels → List<String>
Returns the list of labels that the remote peer is producing
no setter
metadata ← String
Setter function to update the Remote Peer Metadata NOTE: This will NOT notify other Remote Peers of the update
no getter
peerId ↔ String
peerId of the remote peer, this is unique for each peer
getter/setter pair
producerIds → List
no setter
role ↔ String?
Role of the Peer. @returns The Role of the Peer which if passed in the options when creating the token
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addLabelData({required String label, required String producerId}) → Future<void>
callback(Function func, [dynamic arg0, dynamic arg1, dynamic arg2, dynamic arg3, dynamic arg4, dynamic arg5]) → dynamic
inherited
callbackAsFuture(Function func, [dynamic arg0, dynamic arg1, dynamic arg2, dynamic arg3, dynamic arg4, dynamic arg5]) → Future
inherited
clearListeners() → void
This function unbinds all the handlers for all the events
inherited
close() → void
Removes all the states of the remote peer and clears memory; NOTE: You need to close consumers using the recvTransport.closeConsumer of the local peer
emit(String event, [dynamic arg0, dynamic arg1, dynamic arg2, dynamic arg3, dynamic arg4, dynamic arg5]) → void
This function triggers all the handlers currently listening to event and passes them data.
inherited
emitAsFuture(String event, [dynamic arg0, dynamic arg1, dynamic arg2, dynamic arg3, dynamic arg4, dynamic arg5]) → Future
This function triggers all the handlers currently listening to event and passes them data.
inherited
getConsumer(String label) → Consumer?
Get the associated consumer for the label @param label - Unique identifier for the consumer e.g. video | audio | screen-share-video | string @returns Consumer | null
getLabelData(String label) → Map<String, String>?
Returns the data associated to the label, this is the producerId @returns producerId - Unique identifier for the producer
getMetadata<T>() → T
Returns the metadata associated to the RemotePeer
hasLabel(String label) → bool
Checks if the remote peer is producing the label @param label - Label to check if the remote peer is producing @returns - Returns true if the remote peer is producing the label
listeners(dynamic event) → List
Return function list named event.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
off(String event) → void
This function attempts to unbind all the handler from the event
inherited
on(String event, Function handler) → void
This function binds the handler as a listener to the event
inherited
once(String event, Function handler) → void
This function binds the handler as a listener to the first occurrence of the event. When handler is called once, it is removed.
inherited
remove(String event, Function handler) → void
This function attempts to unbind the handler from the event
inherited
removeAllListeners([dynamic eventName]) → void
inherited
removeLabelData(String label, {Map<String, dynamic>? reason}) → void
Remove a Label from the Remote Peer and emit a stream-closed event NOTE: This is used internally by the Peer
safeEmit(String event, [Map<String, dynamic>? args]) → void
inherited
safeEmitAsFuture(String event, [Map<String, dynamic>? args]) → Future
inherited
toString() → String
A string representation of this object.
inherited
updatePermissions(Map<String, dynamic> data) → void
Update the Permissions of the Remote Peer in the Room. This will emit an event updated with the updated permissions.
updateRole(Map<String, dynamic> data) → void
Update the role of the Remote Peer in the Room, this will emit an event updated with the updated role.

Operators

operator ==(Object other) → bool
The equality operator.
inherited