RoomSubscription

@objc
open class RoomSubscription : NSObject, Identifiable

Room SDK におけるSubscription

Core SDK のSubscriptionのラッパークラス

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

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

  • id

    Subscriptionを識別するID

    Declaration

    Swift

    @objc
public var id: String { get }

  • このSubscriptionに紐づくStreamのContentType

    Declaration

    Swift

    @objc
public var contentType: ContentType { get }

  • SubscribeしているPublication

    Declaration

    Swift

    @objc
public var publication: RoomPublication? { get }

  • SubscribeしているRoomMember

    Declaration

    Swift

    @objc
public var subscriber: RoomMember? { get }

  • ステート

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

    Declaration

    Swift

    @objc
public var state: SubscriptionState { get }

  • このSubscriptionに紐づくStream

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

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

    Declaration

    Swift

    @objc
public var stream: RemoteStream? { get }

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

    Declaration

    Swift

    @objc
public var preferredEncodingId: String? { get }

  • イベントデリゲート

    Declaration

    Swift

    @objc
public var delegate: RoomSubscriptionDelegate? { get set }

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

    この設定はSFURoomのみ有効です。

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

    Declaration

    Swift

    @objc
public func changePreferredEncoding(encodingId: String)

    Parameters

    encodingId

    変更するEncoding ID
  • cancel() Asynchronous

    Subscribeを中止します。

    Warning

    SkyWayRoom v2.0.7で非推奨となりました。

    Declaration

    Swift

    @available(iOS, deprecated, introduced: 13.0, message: "SkyWayRoom v2.0.7で非推奨となりました。")
@objc
public func cancel() async throws

  • Subscribeを中止します。

    Warning

    SkyWayRoom v2.0.7で非推奨となりました。

    Declaration

    Swift

    @available(*, deprecated, message: "SkyWayRoom v2.0.7で非推奨となりました。")
@objc
public func cancel(completion: ((Error?) -> Void)?)

    Parameters

    completion

    完了コールバック

  • Warning

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

    Declaration

    Swift

    @available(*, deprecated, message: "SkyWayRoom v2.0.0で非推奨となりました。")
@objc
public func getStats() -> WebRTCStats?

NSObject

  • Undocumented

    Declaration

    Swift

    override open func isEqual(_ object: Any?) -> Bool

  • Undocumented

    Declaration

    Swift

    open override var hash: Int { get }