Publish class

Manages connection with a secure WebSocket path to signal the Millicast server and establishes a WebRTC connection to broadcast a MediaStream.

streamName - Millicast existing stream name. tokenGenerator - Callback function executed when a new token is needed. logger - Logger instance from the extended classes. autoReconnect - Enable auto reconnect.

Inheritance

Constructors

Publish({required String streamName, required Function tokenGenerator, bool autoReconnect = true})

Properties

alreadyDisconnected bool?
getter/setter pairinherited
autoReconnect bool
autoReconnect - Enable auto reconnect.
getter/setter pairinherited
count int
Get the unique count of events registered in the emitter.
no setterinherited
firstReconnection bool?
getter/setter pairinherited
hashCode int
The hash code for this object.
no setterinherited
logger ↔ Logger
logger - Logger instance from the extended classes.
getter/setter pairinherited
options Map<String, dynamic>?
getter/setter pairinherited
reconnectionInterval int?
getter/setter pairinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
signaling Signaling?
getter/setter pairinherited
stopReconnection bool
getter/setter pairinherited
stopReemitingSignalingInstanceEvents Function?
getter/setter pair
stopReemitingWebRTCPeerInstanceEvents Function?
getter/setter pair
streamName String
streamName - Millicast existing stream name.
getter/setter pairinherited
tokenGenerator Function
tokenGenerator - Callback function executed when a new token is needed.
getter/setter pairinherited
webRTCPeer PeerConnection
getter/setter pairinherited

Methods

clear() → void
Clear all subscribers from the cache.
inherited
connect({Map<String, dynamic> options = connectOptions}) → dynamic
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
getRTCPeerConnection() Future<RTCPeerConnection>
Get current RTC peer connection.
inherited
initConnection(Map data) → dynamic
isActive() bool
Get if the current connection is active.
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 - Listener instance 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 - EventCallback function registered to receive events emitted from the publisher. A valid callback function is mandatory.
inherited
reconnect() → dynamic
Reconnects to last broadcast.
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 - EventCallback used when registering subscription using on function.
inherited
replaceConnection() → dynamic
setReconnect() → dynamic
Sets reconnection if autoReconnect is enabled.
inherited
stop() → dynamic
Stops connection.
inherited
toString() String
A string representation of this object.
inherited

Operators

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