Function useConversationStreams
- useConversationStreams(conversation: undefined | Conversation, streamsToPublish?: (undefined | null | {
options?: PublishOptions;
stream: Stream;
})[], errorCallback?: ((error: any) => void)): {
publish: ((localStream: Stream, options?: PublishOptions) => Promise<Stream>);
publishedStreams: Stream[];
replacePublishedStream: ((oldStream: Stream, newStream: Stream) => Promise<Stream>);
subscribedStreams: Stream[];
unpublish: ((localStream: Stream) => void);
unsubscribeAll: (() => void);
}
-
Parameters
-
conversation: undefined | Conversation
-
streamsToPublish: (undefined | null | {
options?: PublishOptions;
stream: Stream;
})[] = EMPTY
-
Optional errorCallback: ((error: any) => void)
-
- (error: any): void
-
Returns void
Returns {
publish: ((localStream: Stream, options?: PublishOptions) => Promise<Stream>);
publishedStreams: Stream[];
replacePublishedStream: ((oldStream: Stream, newStream: Stream) => Promise<Stream>);
subscribedStreams: Stream[];
unpublish: ((localStream: Stream) => void);
unsubscribeAll: (() => void);
}
-
publish: ((localStream: Stream, options?: PublishOptions) => Promise<Stream>)
-
- (localStream: Stream, options?: PublishOptions): Promise<Stream>
-
Parameters
-
localStream: Stream
-
Optional options: PublishOptions
Returns Promise<Stream>
-
publishedStreams: Stream[]
-
replacePublishedStream: ((oldStream: Stream, newStream: Stream) => Promise<Stream>)
-
- (oldStream: Stream, newStream: Stream): Promise<Stream>
-
Parameters
-
oldStream: Stream
-
newStream: Stream
Returns Promise<Stream>
-
subscribedStreams: Stream[]
-
unpublish: ((localStream: Stream) => void)
-
- (localStream: Stream): void
-
Returns void
-
unsubscribeAll: (() => void)
fully managed list of Stream(s) to publish, with associated publish options