RemoteSubtitleStream

Beta

A remote participant stream which can emit subtitle cues for the current participant, or for another participant.

Extends

• TypedEmitter<RemoteSubtitleStreamEventMap>

Implements

• SubtitleStream

Properties

streamType

readonly streamType: SUBTITLE = StreamType.SUBTITLE

Beta

Implementation of

SubtitleStream.streamType

Accessors

participantInfo

Get Signature

get participantInfo(): StageParticipantInfo

Beta

Return participant info associated with this particular Subtitle stream.

Returns

StageParticipantInfo

Methods

hasListenersFor()

hasListenersFor<Event>(event): boolean

Beta

Type Parameters

Type Parameter
Event extends CUE_RECEIVED

Parameters

Parameter	Type	Description
event	Event	the event to register the callback for

Returns

boolean

Inherited from

TypedEmitter.hasListenersFor

---

off()

off<Event>(event, callback, context?): void

Beta

Type Parameters

Type Parameter
Event extends CUE_RECEIVED

Parameters

Parameter	Type	Description
event	Event	the event to de-register the callback for
callback	RemoteSubtitleStreamEventMap[Event]	the callback to be de-registered
context?	any	-

Returns

void

Inherited from

TypedEmitter.off

---

on()

on<Event>(event, callback, context?): void

Beta

Type Parameters

Type Parameter
Event extends CUE_RECEIVED

Parameters

Parameter	Type	Description
event	Event	the event to register the callback for
callback	RemoteSubtitleStreamEventMap[Event]	the callback to be invoked for the event
context?	any	-

Returns

void

Inherited from

TypedEmitter.on