SKWSubscription

Objective-C


@interface SKWSubscription : NSObject

Swift

class Subscription : NSObject

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

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

  • id

    Subscriptionを識別するID

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nonnull id;

    Swift

    var id: String { get }

  • このSubscriptionに紐づくStreamのContentType

    Declaration

    Objective-C

    @property (nonatomic, readonly) SKWContentType contentType;

    Swift

    var contentType: ContentType { get }

  • SubscribeしているPublication

    Declaration

    Objective-C

    @property (nonatomic, readonly) SKWPublication *_Nullable publication;

    Swift

    var publication: SKWPublication? { get }

  • SubscribeしているMember

    Declaration

    Objective-C

    @property (nonatomic, readonly) SKWMember *_Nullable subscriber;

    Swift

    var subscriber: Member? { get }

  • ステート

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

    Declaration

    Objective-C

    @property (nonatomic, readonly) SKWSubscriptionState state;

    Swift

    var state: SubscriptionState { get }

  • このSubscriptionに紐づくStream

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

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

    Declaration

    Objective-C

    @property (nonatomic, readonly) SKWRemoteStream *_Nullable stream;

    Swift

    var stream: RemoteStream? { get }

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

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nullable preferredEncodingId;

    Swift

    var preferredEncodingId: String? { get }

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (id _Nonnull)init NS_UNAVAILABLE;

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

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

    Declaration

    Objective-C

    - (void)changePreferredEncodingWithEncodingId:(NSString *_Nonnull)encodingId;

    Swift

    func changePreferredEncoding(withEncodingId encodingId: String)

  • Subscribeを中止します。

    Declaration

    Objective-C

    - (void)cancelWithCompletion:
    (SKWSubscriptionCancelCompletion _Nullable)completion;

    Swift

    func cancel() async throws

    Parameters

    completion

    完了コールバック

  • Deprecated

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

    Undocumented

    Declaration

    Objective-C

    - (SKWWebRTCStats* _Nullable)getStats
    __attribute__((deprecated("SkyWayCore v2.0.0で非推奨となりました。")));

    Swift

    func getStats() -> WebRTCStats?

  • Undocumented

    See more

    Declaration

    Objective-C

    @property(weak, nonatomic) id<SKWSubscriptionDelegate> _Nullable delegate

    Swift

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