Classes

音声入出力の設定クラス

音声入力ソースの抽象クラス

カメラプレビュー用View

描画するためにはSKWCameraVideoSourceのattachView(_)に引数を渡してください。

StoryboardのCustom Classを利用する場合はCameraPreviewViewではなくSKWCameraPreviewViewを指定して下さい。

カメラキャプチャオプション

それぞれのプロパティからAVCaptureDeviceFormatを決定するために利用されます。

カメラ映像入力ソース

他の映像入力ソースとは異なり、シングルトンインスタンスを利用してください。

インスタンスはSKWCameraVideoSource.shared()から取得できます。

StreamはcreateStream()より作成できますが、実際に映像を描画するためにはstartCapturing(with:options:completion:)でキャプチャを開始する必要があります。

Channel初期化オプション

Channel検索クエリ

Member初期化オプション

チャンネル

コーデックパラメータ

コーデック設定

SkyWay全体の設定、取得を行うStaticなコンテキスト

内部向けオプション

内部向けオプション

内部向けオプション

内部向けオプション

内部向けオプション

WebRTCに関するオプション

トークンに関するオプション

コンテキストの初期化オプション

画像フレームの映像入力ソース

CMSampleBufferの画像フレームをループ内からアップデートして描画を行います。

ReplayKitと組み合わせることでアプリの画面をソースにして画面共有が行えます。

let source: CustomFrameVideoSource = .init()
RPScreenRecorder.shared().startCapture { buffer, _, err in
    guard err == nil else {
        return
    }
    source.updateFrame(with: buffer)
} completionHandler: { _ in }

let stream = source.createStream()

データ入力ソース

エンコーディング設定

動画ファイル入力ソース

ファイルに音声が含まれる場合でも、映像のみ扱われることに注意してください。

フォワードコンフィグ

フォワーディング

Botがフォワードした時に取得できます。

LocalAudioStreamクラス

SourceのcreateStream()から生成してください。

LocalDataStreamクラス

SourceのcreateStream()から生成してください。

このSDKで生成されたLocalMember

抽象LocalStreamクラス

LocalPersonはLocalStreamをSourceから作成し、Publishすることができます。

同じLocalStreamインスタンスを複数回Publishすることはできません。

LocalVideoStreamクラス

各種VideoSourceのcreateStream()から生成してください。

内部Swiftモジュール向けロガークラス

Channelに入室しているMemberの抽象クラス

マイク入力ソース

プラグイン基底クラス

Publication

PublicationはLocalMemberがPublishした時に取得でき、Roomに参加している他クライアント(RemoteMember)がSubscribeされると通信を行います。

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

Publishオプション

RemoteAudioStreamクラス

Undocumented

Undocumented

Undocumented

抽象RemoteStreamクラス

RemoteVideoStream

SFU Bot

すでに存在するPublicationをフォワードし、それをSubscribeすることでSFUサーバ経由での通信ができます。

SFU Bot プラグイン

Contextに登録することでSFU Botを利用することができます。

let sfu: SFUBotPlugin = .init(options: nil)
Context.registerPlugin(sfu)

SFU Botに関しては公式ホームページの開発ドキュメントをご確認ください。

SFUBotPluginオプション

Stream抽象クラス

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

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

Subscribeオプション

Undocumented

映像入力ソースの抽象クラス

Videoを描画するView

描画するためにはSKWLocalVideoStreamまたはSKWRemoteVideoStreamのattach(_:)に引数を渡してください。

StoryboardのCustom Classを利用する場合はVideoViewではなくSKWVideoViewを指定して下さい。

グラフィックスAPIはMetalを利用しています。

Publishオプション

RoomのLocalMember

このLocalMemberはRoomのjoin(with:)から生成できます。

一つのRoomインスタンスには一つのLocalRoomMemberがjoinでき、複数管理することはできません。

他のSDKで生成されたRoomMember

Roomに入室しているMemberの抽象クラス

P2PRoomのLocalMember

このLocalMemberはP2PRoomのjoin(with:)から生成できます。

一つのRoomインスタンスには一つのLocalRoomMemberがjoinでき、複数管理することはできません。

メソッドに関しては、LocalRoomMemberクラスをご確認ください。

P2P通信を行うRoom

Room抽象クラスもご確認ください。

Room SDKにおけるPublication

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

PublicationはLocalMemberがPublishした時に取得でき、Roomに参加している他クライアント(RemoteMember)がSubscribeされると通信を行います。

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

Roomクラス

メディア通信毎に P2P と SFU の方式を選択できます。

RoomにはMemberが入退出できます。Room作成時点のように、Memberのいない状態のRoomも存在できます。

詳しくは公式ホームページのドキュメントをご確認ください。

SFURoomのLocalMember

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

Room SDK におけるSubscription

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

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

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