Signaling class
Starts WebSocketChannel connection and manages the messages between peers.
establish a WebRTC connection.
var millicastSignaling = Signaling(options);
- Inheritance
-
- Object
- EventEmitter
- Signaling
Properties
- count → int
-
Get the unique count of events registered in the emitter.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- isMigrating ↔ bool?
-
getter/setter pair
- remoteSdp ↔ RTCSessionDescription?
-
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- streamName ↔ String?
-
streamName - Millicast stream name to get subscribed.
getter/setter pair
- transactionManager ↔ TransactionManager?
-
getter/setter pair
- webSocket ↔ WebSocketChannel?
-
getter/setter pair
- wsUrl ↔ String
-
wsUrl URL is used to initialize a webSocket with Millicast server and
getter/setter pair
Methods
-
clear(
) → void -
Clear all subscribers from the cache.
inherited
-
close(
) → void - Close WebSocket connection with Millicast server.
-
cmd(
String cmd, Object data) → dynamic - Send command to the server.
-
connect(
) → Future< WebSocketChannel> - Starts a WebSocket connection with signaling server.
-
emit(
String event, [Object? sender, Object? data]) → void -
API to emit events.
event is a required parameter.
If sender information is sent, it will be used to intimate user about it.
event- What event needs to be emitted.sender- The sender who published the event. Ignore if not required.data- Data the event need to carry. Ignore this argument if no data needs to be sent.inherited -
getListenersCount(
String event) → int -
Get the list of subscribers for a particular event.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
off(
Listener? listener) → void -
Remove event listener from emitter.
This will unsubscribe the caller from the emitter from any future events.
Listener should be a valid instance.
listener-Listenerinstance to be removed from the event subscription.inherited -
on(
String event, Object? context, EventCallback callback) → Listener -
API to register for notification.
It is mandatory to pass event name and callback parameters.
event- Event name used for the subscription. A valid event name is mandatory.context- Context information, which need to be sent in all emitted events.callback-EventCallbackfunction registered to receive events emitted from the publisher. A valid callback function is mandatory.inherited -
publish(
String? sdp, {Map< String, dynamic> ? options}) → Future<String> - Establish WebRTC connection with Millicast Server as Publisher role.
-
removeAllByCallback(
EventCallback callback) → void -
Remove all listeners which matches with the callback provided.
It is possible to register for multiple events with a single callback.
This mechanism ensure that all event registrations would be cancelled which matches the callback.
callback- The event callback used during subscription.inherited -
removeAllByEvent(
String event) → void -
Use this mechanism to remove all subscription for a particular event.
Caution : This will remove all the listeners from multiple files or classes or modules.
Think twice before calling this API and make sure you know what you are doing!!!
event- Event name used during subscription.inherited -
removeListener(
String eventName, EventCallback callback) → void -
Unsubscribe from getting any future events from emitter.
This mechanism uses event name and callback to unsubscribe from all possible events.
eventName- Event name for the subscription.callback-EventCallbackused when registering subscription using on function.inherited -
subscribe(
String sdp, {Map< String, dynamic> ? options}) → Future<String> - Establish WebRTC connection with Millicast Server as Subscriber role.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited