Classes

音声入出力の設定クラス

See more

class AudioSettings : NSObject

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

See more

class AudioSource : NSObject

カメラプレビュー用View

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

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

See more

class CameraPreviewView : UIView

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

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

See more

class CameraCaptureOptions : NSObject

カメラ映像入力ソース

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

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

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

See more

class CameraVideoSource : VideoSource

Channel初期化オプション

See more

class ChannelInit : NSObject

Channel検索クエリ

See more

class ChannelQuery : NSObject

Member初期化オプション

See more

class MemberInit : NSObject

チャンネル

See more

class Channel : NSObject

コーデックパラメータ

See more

class CodecParameters : NSObject

コーデック設定

See more

class Codec : NSObject

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

See more

class Context : NSObject

内部向けオプション

See more

class ContextOptionsRTCAPI : NSObject

内部向けオプション

See more

class ContextOptionsICEParams : NSObject

内部向けオプション

See more

class ContextOptionsSignaling : NSObject

内部向けオプション

See more

class ContextOptionsAnalytics : NSObject

WebRTCに関するオプション

See more

class ContextOptionsRTCConfig : NSObject

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

See more

class ContextOptionsToken : NSObject

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

See more

class ContextOptions : NSObject

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

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()

See more

class CustomFrameVideoSource : VideoSource

データ入力ソース

See more

class DataSource : NSObject

エンコーディング設定

See more

class Encoding : NSObject

動画ファイル入力ソース

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

See more

class FileVideoSource : VideoSource

フォワードコンフィグ

See more

フォワーディング

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

See more

LocalAudioStreamクラス

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

class LocalAudioStream : LocalStream

LocalDataStreamクラス

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

See more

class LocalDataStream : LocalStream

このSDKで生成されたLocalMember

See more

class LocalPerson : Member

抽象LocalStreamクラス

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

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

See more

class LocalStream : Stream

LocalVideoStreamクラス

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

See more

class LocalVideoStream : LocalStream, VideoStreamProtocol

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

See more

class Logger : NSObject

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

See more

class Member : NSObject

マイク入力ソース

See more

class MicrophoneAudioSource : AudioSource

プラグイン基底クラス

See more

class Plugin : NSObject

Publication

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

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

See more

class Publication : NSObject

Publishオプション

See more

class PublicationOptions : NSObject

RemoteAudioStreamクラス

class RemoteAudioStream : RemoteStream

Undocumented

See more

class RemoteDataStream : RemoteStream

Undocumented

class RemoteMember : Member

Undocumented

See more

class RemotePerson : RemoteMember

抽象RemoteStreamクラス

class RemoteStream : Stream

RemoteVideoStream

See more

class RemoteVideoStream : RemoteStream, VideoStreamProtocol

SFU Bot

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

See more

SFU Bot プラグイン

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

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

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

See more

class SFUBotPlugin

SFUBotPluginオプション

See more

class SFUBotPluginOptions : NSObject

Stream抽象クラス

See more

class Stream : NSObject

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

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

See more

class Subscription : NSObject

Subscribeオプション

See more

class SubscriptionOptions : NSObject

Undocumented

class UnknownMember : RemoteMember

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

See more

class VideoSource : NSObject

Videoを描画するView

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

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

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

See more

class VideoView : UIView

See more

class WebRTCStats : NSObject

See more

class WebRTCStatsReport : NSObject

Publishオプション

See more

@objc
open class RoomPublicationOptions : PublicationOptions

このSDKで生成されたRoomMemberの抽象クラス

See more

@objc
open class LocalRoomMember : RoomMember

他のSDKで生成されたRoomMember

See more

@objc
open class RemoteRoomMember : RoomMember

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

See more

@objc
open class RoomMember : NSObject, Identifiable

P2PRoomのLocalMember

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

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

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

@objc
open class LocalP2PRoomMember : LocalRoomMember

P2P通信を行うRoom

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

See more

@objc
open class P2PRoom : Room

Room SDKにおけるPublication

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

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

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

See more

@objc
open class RoomPublication : NSObject, Identifiable

Room抽象クラス

RoomとはCore SDKのChannelのラッパークラスです。

Room SDKをご利用いただく場合はChannelというドメインは隠蔽されているので、ChannelではなくRoomを扱います。

RoomにはP2PRoomとSFURoomが存在し、ユースケースに応じて選択してください。

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

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

See more

@objc
open class Room : NSObject, Identifiable

SFURoomのLocalMember

See more

@objc
open class LocalSFURoomMember : LocalRoomMember

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

See more

@objc
open class SFURoom : Room

Room SDK におけるSubscription

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

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

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

See more

@objc
open class RoomSubscription : NSObject, Identifiable