SFURoom

@objc
open class SFURoom : Room

SFUサーバを介して通信を行うRoom

  • Roomを作成します。

    Declaration

    Swift

    @available(iOS 13.0, *)
@objc
public static func create(
    with options: InitOptions?,
    sfuOptions: SFUBotPluginOptions? = nil
) async throws -> SFURoom

    Parameters

    options

    optionsでRoomの名前を指定して作成できますが、同じ名前のRoomは作成することができません。
    sfuOptions

    内部向けオプションのため、設定は不要です。

    Return Value

    Room

  • Roomを作成します。

    optionsでRoomの名前を指定して作成できますが、同じ名前のRoomは作成することができません。

    Declaration

    Swift

    @objc
public static func create(
    with options: InitOptions?,
    sfuOptions: SFUBotPluginOptions? = nil,
    completion: ((SFURoom?, Error?) -> Void)?
)

    Parameters

    options

    初期化オプション
    sfuOptions

    内部向けオプションのため、設定は不要です。
    completion

    完了コールバック
  • find(by:sfuOption:) Asynchronous

    Roomクエリを元にRoomを検索します。

    クエリはRoomのIDまたはNameを入力します。両方とも入力される場合はIDが優先されます。

    Declaration

    Swift

    @available(iOS 13.0, *)
@objc
public static func find(by query: Query, sfuOption: SFUBotPluginOptions? = nil)
    async throws
    -> SFURoom

    Parameters

    query

    検索クエリ
    sfuOptions

    内部向けオプションのため、設定は不要です。

    Return Value

    Room

  • Roomクエリを元にRoomを検索します。

    クエリはRoomのIDまたはNameを入力します。両方とも入力される場合はIDが優先されます。

    Declaration

    Swift

    @objc
public static func find(
    by query: Query,
    sfuOptions: SFUBotPluginOptions? = nil,
    completion: ((SFURoom?, Error?) -> Void)?
)

    Parameters

    query

    検索クエリ
    sfuOptions

    内部向けオプションのため、設定は不要です。
    completion

    完了コールバック

  • Roomを名前から検索し、存在しない場合は作成します。

    Declaration

    Swift

    @available(iOS 13.0, *)
@objc
public static func findOrCreate(
    with options: InitOptions,
    sfuOptions: SFUBotPluginOptions? = nil
) async throws -> SFURoom

    Parameters

    options

    検索・初期化オプション
    sfuOptions

    内部向けオプションのため、設定は不要です。

    Return Value

    Room

  • Roomを名前から検索し、存在しない場合は作成します。

    Declaration

    Swift

    @objc
public static func findOrCreate(
    with options: InitOptions,
    sfuOptions: SFUBotPluginOptions? = nil,
    completion: ((SFURoom?, Error?) -> Void)?
)

    Parameters

    options

    検索・初期化オプション
    sfuOptions

    内部向けオプションのため、設定は不要です。
    completion

    完了コールバック
  • join(with:) Asynchronous

    RoomにLocalRoomMemberを作成し、入室させます。

    1RoomインスタンスにJoinできるLocalRoomMemberは1人だけです。

    Declaration

    Swift

    @available(iOS 13.0, *)
override public func join(with options: Room.MemberInitOptions?) async throws
    -> LocalSFURoomMember

    Parameters

    options

    Member初期化オプション

    Return Value

    Member

  • RoomにLocalRoomMemberを作成し、入室させます。

    1RoomインスタンスにJoinできるLocalRoomMemberは1人だけです。

    Declaration

    Swift

    override public func join(
    with options: Room.MemberInitOptions?,
    completion: ((LocalSFURoomMember?, Error?) -> Void)?
)

    Parameters

    options

    Member初期化オプション
    completion

    完了コールバック

  • 入室しているメンバーの一覧

    Declaration

    Swift

    override public var members: [RoomMember] { get }

  • このRoomでPublishされているStreamのPublication一覧

    Declaration

    Swift

    override public var publications: [RoomPublication] { get }

  • このRoomでSubscribeされているSubscription一覧

    Declaration

    Swift

    override public var subscriptions: [RoomSubscription] { get }