Type alias PublicationOptions

PublicationOptions: {
    codecCapabilities?: Codec[];
    encodings?: EncodingParameters[];
    isEnabled?: boolean;
    metadata?: string;
    type?: PublicationType;
}

Type declaration

  • Optional codecCapabilities?: Codec[]

    Description

    [japanese] publishする際に優先して利用するCodec設定を指定する。 利用するCodecは配列の先頭が優先される。

  • Optional encodings?: EncodingParameters[]

    Description

    [japanese] メディアのエンコードの設定を行うことができる。 サイマルキャストに対応している通信モデル（SFU）を利用している場合、encodingsの配列に複数のEncodingを設定するとサイマルキャストが有効になる。 この時、encodingの配列はビットレートの低い順にソートされて設定される。 P2Pを利用している場合、最もビットレートの低い設定のみが適用される。

  • Optional isEnabled?: boolean

    Description

    [japanese] publicationを有効にしてpublishするか指定する。 デフォルトではtrueが設定される。 falseに設定された場合、publicationは一時停止された状態でpublishされる。

  • Optional metadata?: string
  • Optional type?: PublicationType

    Description

    [japanese] DefaultRoom利用時に、publicationがP2Pで利用されるかSFUで利用されるかを指定する。 デフォルトではP2Pが設定される。

Settings

Member Visibility

Theme