Class SfuBotMember

Hierarchy

  • MemberImpl
    • SfuBotMember

Implements

  • RemoteMemberImplInterface

Properties

channel context id name? onForwardingListChanged onForwardingStarted onForwardingStopped onLeft onMetadataUpdated options side subtype type subtype

Accessors

forwardings metadata publications state subscriptions

Methods

leave startForwarding stopForwarding updateMetadata

Properties

Readonly channel

channel: SkyWayChannelImpl

Readonly context

context: SkyWayContext

Readonly id

id: string

Optional Readonly name

name?: string

Readonly onForwardingListChanged

onForwardingListChanged: Event<void> = ...

Description

[japanese] forwardingの数が変化した時に発火するイベント

Readonly onForwardingStarted

onForwardingStarted: Event<{
    forwarding: Forwarding;
}> = ...

Type declaration

Description

[japanese] forwardingを開始した時に発火するイベント

Readonly onForwardingStopped

onForwardingStopped: Event<{
    forwarding: Forwarding;
}> = ...

Type declaration

Description

[japanese] forwardingを終了した時に発火するイベント

Readonly onLeft

onLeft: Event<void>

Readonly onMetadataUpdated

onMetadataUpdated: Event<string>

Readonly options

options: SfuBotPluginOptions

Readonly side

side: "remote" = 'remote'

Readonly subtype

subtype: "sfu" = SfuBotMember.subtype

Readonly type

type: MemberType = 'bot'

Static Readonly subtype

subtype: "sfu" = 'sfu'

Accessors

forwardings

metadata

  • get metadata(): undefined | string

  • Returns undefined | string

publications

  • get publications(): Publication<LocalStream>[]

  • Returns Publication<LocalStream>[]

state

  • get state(): MemberState

  • Returns MemberState

subscriptions

  • get subscriptions(): Subscription<RemoteStream>[]

  • Returns Subscription<RemoteStream>[]

Methods

leave

  • leave(): Promise<void>

  • Returns Promise<void>

    Throws

    SkyWayError

startForwarding

  • startForwarding(publication, configure?): Promise<Forwarding>

  • Parameters

    • publication: Publication<LocalAudioStream | LocalVideoStream | LocalCustomVideoStream>
    • configure: Partial<ForwardingConfigure> = {}

    Returns Promise<Forwarding>

    Description

    [japanese] StreamのPublicationをForwardingする

    Throws

    Example

    const forwarding = await bot.startForwarding(publication, { maxSubscribers: 99 });

stopForwarding

  • stopForwarding(target): Promise<void>

  • Parameters

    Returns Promise<void>

    Description

    [japanese] Forwardingを停止する

updateMetadata

  • updateMetadata(metadata): Promise<void>

  • Parameters

    • metadata: string

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc