Classes Reference


                    
                    
                    SKWAudioSettings

音声出力の設定クラス

Declaration

Objective-C


@interface SKWAudioSettings : NSObject

Swift

class AudioSettings : NSObject


                    
                    
                    SKWAudioSource

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

Declaration

Objective-C


@interface SKWAudioSource : NSObject

Swift

class AudioSource : NSObject


                    
                    
                    SKWCameraPreviewView

カメラプレビュー用View

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

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

Declaration

Objective-C


@interface SKWCameraPreviewView


                    
                    
                    SKWCameraCaptureOptions

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

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

Declaration

Objective-C


@interface SKWCameraCaptureOptions : NSObject

Swift

class CameraCaptureOptions : NSObject


                    
                    
                    SKWCameraVideoSource

カメラ映像入力ソース

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

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

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

Declaration

Objective-C


@interface SKWCameraVideoSource : SKWVideoSource

Swift

class CameraVideoSource : VideoSource


                    
                    
                    SKWChannelInit

Channel初期化オプション

Declaration

Objective-C


@interface SKWChannelInit : NSObject

Swift

class ChannelInit : NSObject


                    
                    
                    SKWChannelQuery

Channel検索クエリ

Declaration

Objective-C


@interface SKWChannelQuery : NSObject

Swift

class ChannelQuery : NSObject


                    
                    
                    SKWMemberInit

Member初期化オプション

Declaration

Objective-C


@interface SKWMemberInit : NSObject

Swift

class MemberInit : NSObject


                    
                    
                    SKWChannel

チャンネル

Declaration

Objective-C


@interface SKWChannel : NSObject

Swift

class Channel : NSObject


                    
                    
                    SKWCodecParameters

コーデックパラメータ

Declaration

Objective-C


@interface SKWCodecParameters : NSObject

Swift

class CodecParameters : NSObject


                    
                    
                    SKWCodec

コーデック設定

Declaration

Objective-C


@interface SKWCodec : NSObject

Swift

class Codec : NSObject


                    
                    
                    SKWContext

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

Declaration

Objective-C


@interface SKWContext : NSObject

Swift

class Context : NSObject


                    
                    
                    SKWContextOptionsRTCAPI

内部向けオプション

Declaration

Objective-C


@interface SKWContextOptionsRTCAPI : NSObject

Swift

class ContextOptionsRTCAPI : NSObject


                    
                    
                    SKWContextOptionsICEParams

内部向けオプション

Declaration

Objective-C


@interface SKWContextOptionsICEParams : NSObject

Swift

class ContextOptionsICEParams : NSObject


                    
                    
                    SKWContextOptionsSignaling

内部向けオプション

Declaration

Objective-C


@interface SKWContextOptionsSignaling : NSObject

Swift

class ContextOptionsSignaling : NSObject


                    
                    
                    SKWContextOptionsAnalytics

内部向けオプション

Declaration

Objective-C


@interface SKWContextOptionsAnalytics : NSObject

Swift

class ContextOptionsAnalytics : NSObject


                    
                    
                    SKWContextOptionsRTCConfig

WebRTCに関するオプション

Declaration

Objective-C


@interface SKWContextOptionsRTCConfig : NSObject

Swift

class ContextOptionsRTCConfig : NSObject


                    
                    
                    SKWContextOptionsToken

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

Declaration

Objective-C


@interface SKWContextOptionsToken : NSObject

Swift

class ContextOptionsToken : NSObject


                    
                    
                    SKWContextOptions

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

Declaration

Objective-C


@interface SKWContextOptions : NSObject

Swift

class ContextOptions : NSObject


                    
                    
                    SKWCustomFrameVideoSource

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

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

Declaration

Objective-C


@interface SKWCustomFrameVideoSource : SKWVideoSource

Swift

class CustomFrameVideoSource : VideoSource


                    
                    
                    SKWDataSource

データ入力ソース

Declaration

Objective-C


@interface SKWDataSource : NSObject

Swift

class DataSource : NSObject


                    
                    
                    SKWEncoding

エンコーディング設定

Declaration

Objective-C


@interface SKWEncoding : NSObject

Swift

class Encoding : NSObject


                    
                    
                    SKWErrorFactory

エラーファクトリー

Declaration

Objective-C

@interface SKWErrorFactory : NSObject

Swift

class SKWErrorFactory : NSObject


                    
                    
                    SKWFileVideoSource

動画ファイル入力ソース

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

Declaration

Objective-C


@interface SKWFileVideoSource : SKWVideoSource

Swift

class FileVideoSource : VideoSource


                    
                    
                    SKWLocalAudioStream

LocalAudioStreamクラス

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

Declaration

Objective-C


@interface SKWLocalAudioStream : SKWLocalStream

Swift

class LocalAudioStream : LocalStream


                    
                    
                    SKWLocalDataStream

LocalDataStreamクラス

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

Declaration

Objective-C


@interface SKWLocalDataStream : SKWLocalStream

Swift

class LocalDataStream : LocalStream


                    
                    
                    SKWLocalPerson

このSDKで生成されたLocalMember

Declaration

Objective-C


@interface SKWLocalPerson : SKWMember

Swift

class LocalPerson : Member


                    
                    
                    SKWLocalStream

抽象LocalStreamクラス

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

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

Declaration

Objective-C


@interface SKWLocalStream : SKWStream

Swift

class LocalStream : Stream


                    
                    
                    SKWLocalVideoStream

LocalVideoStreamクラス

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

Declaration

Objective-C


@interface SKWLocalVideoStream : SKWLocalStream <SKWVideoStreamProtocol>

Swift

class LocalVideoStream : LocalStream, VideoStreamProtocol


                    
                    
                    SKWLogger

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

Declaration

Objective-C


@interface SKWLogger : NSObject

Swift

class Logger : NSObject


                    
                    
                    SKWMember

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

Declaration

Objective-C


@interface SKWMember : NSObject

Swift

class Member : NSObject


                    
                    
                    SKWMicrophoneAudioSource

マイク入力ソース

Declaration

Objective-C


@interface SKWMicrophoneAudioSource : SKWAudioSource

Swift

class MicrophoneAudioSource : AudioSource


                    
                    
                    SKWPlugin

プラグイン基底クラス

Declaration

Objective-C


@interface SKWPlugin : NSObject

Swift

class Plugin : NSObject


                    
                    
                    SKWPublication

Publication

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

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

Declaration

Objective-C


@interface SKWPublication : NSObject

Swift

class Publication : NSObject


                    
                    
                    SKWPublicationOptions

Publishオプション

Declaration

Objective-C


@interface SKWPublicationOptions : NSObject

Swift

class PublicationOptions : NSObject


                    
                    
                    SKWRemoteAudioStream

RemoteAudioStreamクラス

Declaration

Objective-C


@interface SKWRemoteAudioStream : SKWRemoteStream

Swift

class RemoteAudioStream : RemoteStream


                    
                    
                    SKWRemoteDataStream

RemoteDataStreamクラス

Declaration

Objective-C


@interface SKWRemoteDataStream : SKWRemoteStream

Swift

class RemoteDataStream : RemoteStream


                    
                    
                    SKWRemoteMember

Undocumented

Declaration

Objective-C


@interface SKWRemoteMember : SKWMember

Swift

class RemoteMember : Member


                    
                    
                    SKWRemotePerson

Undocumented

Declaration

Objective-C


@interface SKWRemotePerson : SKWRemoteMember

Swift

class RemotePerson : RemoteMember


                    
                    
                    SKWRemoteStream

抽象RemoteStreamクラス

Declaration

Objective-C


@interface SKWRemoteStream : SKWStream

Swift

class RemoteStream : Stream


                    
                    
                    SKWRemoteVideoStream

RemoteVideoStream

Declaration

Objective-C


@interface SKWRemoteVideoStream : SKWRemoteStream <SKWVideoStreamProtocol>

Swift

class RemoteVideoStream : RemoteStream, VideoStreamProtocol


                    
                    
                    SKWStream

Stream抽象クラス

Declaration

Objective-C


@interface SKWStream : NSObject

Swift

class Stream : NSObject


                    
                    
                    SKWSubscription

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

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

Declaration

Objective-C


@interface SKWSubscription : NSObject

Swift

class Subscription : NSObject


                    
                    
                    SKWSubscriptionOptions

Subscribeオプション

Declaration

Objective-C


@interface SKWSubscriptionOptions : NSObject

Swift

class SubscriptionOptions : NSObject


                    
                    
                    SKWUnknownMember

Undocumented

Declaration

Objective-C

@interface SKWUnknownMember : SKWRemoteMember

Swift

class SKWUnknownMember : RemoteMember


                    
                    
                    SKWVideoSource

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

Declaration

Objective-C


@interface SKWVideoSource : NSObject

Swift

class VideoSource : NSObject


                    
                    
                    SKWVideoView

Videoを描画するView

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

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

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

Declaration

Objective-C


@interface SKWVideoView


                    
                    
                    SKWWebRTCStats

Deprecated

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

Declaration

Objective-C


@interface SKWWebRTCStats : NSObject

Swift

class WebRTCStats : NSObject


                    
                    
                    SKWWebRTCStatsReport

Deprecated

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

Declaration

Objective-C


@interface SKWWebRTCStatsReport : NSObject

Swift

class WebRTCStatsReport : NSObject