Class LocalCustomVideoStream

Hierarchy (view full)

Constructors

constructor

Properties

contentType id onConnectionStateChanged onDestroyed onTrackUpdated published side

Accessors

isEnabled track

Methods

attach detach getConnectionState getRTCPeerConnection getStats release toJSON

Constructors

constructor

Properties

Readonly contentType

contentType: "video" = 'video'

Readonly id

id: string = ...

Readonly onConnectionStateChanged

onConnectionStateChanged: Event<{
    remoteMember: RemoteMember;
    state: TransportConnectionState;
}> = ...

Type declaration

Deprecated

Use

Publication.onConnectionStateChanged

Description

[japanese] メディア通信の状態が変化した時に発火するイベント

onDestroyed

onDestroyed: Event<void> = ...

Description

[japanese] streamが破棄された時に発火するイベント (例. 画面共有が終了したときなど)

Example

[japanese] ハンドリング例
 const publication = await member.publish(audio);
   audio.onDestroyed.once(async () => {
     await member.unpublish(publication);
   });

onTrackUpdated

onTrackUpdated: Event<MediaStreamTrack> = ...

Description

[japanese] PublicationのDisable/EnableなどでStreamのtrackが更新された時に発火するイベント

published

published: boolean = false

Readonly side

side: "local" = 'local'

Accessors

isEnabled

  • get isEnabled(): boolean

  • Returns boolean

    Deprecated

    Use

    Publication.state

track

  • get track(): MediaStreamTrack

  • Returns MediaStreamTrack

Methods

attach

  • attach(element): void

  • Parameters

    • element: HTMLAudioElement | HTMLVideoElement

    Returns void

    Description

    [english] Attach the stream to the element.

    Description

    [japanese] streamをelementに適用する.

detach

  • detach(): void

  • Returns void

    Description

    [english] Detach the stream from the element.

    Description

    [japanese] elementからstreamを取り除く.

getConnectionState

getRTCPeerConnection

  • getRTCPeerConnection(selector): undefined | RTCPeerConnection

  • Parameters

    Returns undefined | RTCPeerConnection

    Deprecated

    Use

    Publication.getRTCPeerConnection

getStats

release

  • release(): void

  • Returns void

    Description

    [japanese] Streamを解放します。 カメラやマイクなどのデバイスを解放するためにはそのデバイスに関連するすべてのStreamを解放する必要があります

toJSON

  • toJSON(): {
        _options: Partial<LocalMediaStreamOptions>;
        contentType: ContentType;
        id: string;
        isEnabled: boolean;
        label: string;
        side: string;
        trackConstraints: MediaTrackConstraints;
    }

  • Returns {
        _options: Partial<LocalMediaStreamOptions>;
        contentType: ContentType;
        id: string;
        isEnabled: boolean;
        label: string;
        side: string;
        trackConstraints: MediaTrackConstraints;
    }

Settings

Member Visibility

Theme

On This Page

constructorcontentTypeidonConnectionStateChangedonDestroyedonTrackUpdatedpublishedsideisEnabledtrackattachdetachgetConnectionStategetRTCPeerConnectiongetStatsreleasetoJSON