LocalRoomMember

@objc
open class LocalRoomMember : RoomMember

このSDKで生成されたRoomMemberの抽象クラス

  • イベントデリゲート

    Declaration

    Swift

    @objc
    public var delegate: LocalRoomMemberDelegate? { get set }
  • publish(_:options:) Asynchronous

    入室しているRoomにStreamをPublishします。

    Streamは各種Sourceから作成できます。

    同じインスタンスのStreamを複数回Publishすることはできません。必要ならば各種Sourceから再度作成してPublishしてください。

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

    Declaration

    Swift

    @available(iOS 13.0, *)
    @objc
    public func publish(_ stream: LocalStream, options: RoomPublicationOptions?) async throws
        -> RoomPublication

    Parameters

    stream

    PublishするStream

    options

    Publishオプション

    Return Value

    RoomPublication

  • 入室しているRoomにStreamをPublishします。

    Streamは各種Sourceから作成できます。

    同じインスタンスのStreamを複数回Publishすることはできません。必要ならば各種Sourceから再度作成してPublishしてください。

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

    Declaration

    Swift

    @objc
    public func publish(
        _ stream: LocalStream,
        options: RoomPublicationOptions?,
        completion: ((RoomPublication?, Error?) -> Void)?
    )

    Parameters

    stream

    PublishするStream

    options

    Publishオプション

    completion

    完了コールバック

  • Publishを停止します。

    Declaration

    Swift

    @available(iOS 13.0, *)
    @objc
    public func unpublish(publicationId: String) async throws

    Parameters

    publicationId

    停止するPublicationのID

  • Publishを停止します。

    Declaration

    Swift

    @objc
    public func unpublish(publicationId: String, completion: ((Error?) -> Void)?)

    Parameters

    publicationId

    停止するPublicationのID

    completion

    完了コールバック

  • PublicationをSubscribeします。

    オプションについては Core SDK のリファレンスもご確認ください。

    Declaration

    Swift

    @available(iOS 13.0, *)
    @objc
    public func subscribe(publicationId: String, options: SubscriptionOptions?) async throws
        -> RoomSubscription

    Parameters

    publicationId

    SubscribeするPublicationのID

    options

    Subscribeオプション

    Return Value

    Subscription

  • PublicationをSubscribeします。

    オプションについては Core SDK のリファレンスもご確認ください。

    Declaration

    Swift

    @objc
    public func subscribe(
        publicationId: String,
        options: SubscriptionOptions?,
        completion: ((RoomSubscription?, Error?) -> Void)?
    )

    Parameters

    publicationId

    SubscribeするPublicationのID

    options

    Subscribeオプション

    completion

    完了コールバック

  • Subscribeを中止します。

    Declaration

    Swift

    @available(iOS 13.0, *)
    @objc
    public func unsubscribe(subscriptionId: String) async throws

    Parameters

    subscriptionId

    中止するSubscriptionのID

  • Subscribeを中止します。

    Declaration

    Swift

    @objc
    public func unsubscribe(subscriptionId: String, completion: ((Error?) -> Void)?)

    Parameters

    subscriptionId

    中止するSubscriptionのID

    • completion: 完了コールバック