Subscription

class Subscription : NSObject

SubscriptionはLocalMemberがSubscribeした時に取得でき、Subscriptionに含まれるStreamを利用して映像を描画したりします。

Channelなどから他の人のSubscriptionも取得することはできますが、その場合Streamは含まれません。

  • id

    Subscriptionを識別するID

    Declaration

    Swift

    var id: String { get }

  • このSubscriptionに紐づくStreamのContentType

    Declaration

    Swift

    var contentType: ContentType { get }

  • SubscribeしているPublication

    Declaration

    Swift

    var publication: SKWPublication? { get }

  • SubscribeしているMember

    Declaration

    Swift

    var subscriber: Member? { get }

  • ステート

    canceledの場合、このオブジェクトの操作は無効です。

    Declaration

    Swift

    var state: SubscriptionState { get }

  • このSubscriptionに紐づくStream

    LocalPersonがSubscribeし、成功した時の返り値または完了コールバックで得られるSubscriptionにおいては値がSetされていることが保証されています。

    その他、イベントによってSubscriptionを取得した場合、まだ値がSetされていない可能性があります。

    Declaration

    Swift

    var stream: RemoteStream? { get }

  • 優先エンコーディング設定

    Declaration

    Swift

    var preferredEncodingId: String? { get }

  • イベントデリゲート

    Declaration

    Swift

    weak var delegate: (any SubscriptionDelegate)? { get set }

  • Unavailable

    Undocumented

  • Simulcastで利用するPreferredEncodingIDを変更します。

    LocalRoomMemberがSFU bot がforwardingしたPublicationをSubscribeした時のSubscriptionで、ContentTypeがAudioまたはVideoの時のみ変更ができます。

    Declaration

    Swift

    func changePreferredEncoding(withEncodingId encodingId: String) -> Bool

  • Deprecated

    SkyWayCore v2.0.0で非推奨となりました。

    Declaration

    Swift

    func getStats() -> WebRTCStats?