SKWPublicationOptions

Objective-C

@interface SKWPublicationOptions : NSObject

/// Publicationに付与するメタデータ
@property NSString* _Nullable metadata;

/// 指定コーデック
///
/// SkyWayが対応していないコーデックが選択された場合はこのオプションは無視されます。
///
/// SFU Botは非対応です。 SFU RoomのPublishまたはSFU
/// BotにおけるStartForwardingでこの値が設定されている場合は失敗します。
@property NSArray<SKWCodec*>* _Nonnull codecCapabilities;

/// エンコーディング設定
///
/// SFUを利用する場合、複数設定がある場合のみサイマルキャストが有効になります。
///
/// P2P通信において複数設定されている場合は最大ビットレートが低いまたはスケールダウン指数が高いエンコーディング設定が有効になります。
///
/// 詳しい設定例については開発者ドキュメントの[大規模会議アプリを実装する上での注意点](https://skyway.ntt.com/ja/docs/user-guide/tips/large-scale/)をご覧ください。
@property NSArray<SKWEncoding*>* _Nonnull encodings;

/// Publicationが有効かどうか
@property BOOL isEnabled;

@end

Swift

class PublicationOptions : NSObject

Undocumented

  • Publicationに付与するメタデータ

    Declaration

    Objective-C

    @property NSString *_Nullable metadata;

    Swift

    var metadata: String? { get set }

  • 指定コーデック

    SkyWayが対応していないコーデックが選択された場合はこのオプションは無視されます。

    SFU Botは非対応です。 SFU RoomのPublishまたはSFU BotにおけるStartForwardingでこの値が設定されている場合は失敗します。

    Declaration

    Objective-C

    @property NSArray<SKWCodec *> *_Nonnull codecCapabilities;

    Swift

    var codecCapabilities: [Codec] { get set }

  • エンコーディング設定

    SFUを利用する場合、複数設定がある場合のみサイマルキャストが有効になります。

    P2P通信において複数設定されている場合は最大ビットレートが低いまたはスケールダウン指数が高いエンコーディング設定が有効になります。

    詳しい設定例については開発者ドキュメントの大規模会議アプリを実装する上での注意点をご覧ください。

    Declaration

    Objective-C

    @property NSArray<SKWEncoding *> *_Nonnull encodings;

    Swift

    var encodings: [Encoding] { get set }

  • Publicationが有効かどうか

    Declaration

    Objective-C

    @property BOOL isEnabled;

    Swift

    var isEnabled: Bool { get set }