SKWMediaStream クラス

メディアストリーム [詳解]

#import <SKWMediaStream.h>

SKWMediaStream の継承関係図

実体メソッド
(void)	- close
	メディアストリームをすべて閉じます。
(NSUInteger)	- getVideoTracks
	メディアストリームに追加されているビデオトラック数を取得します。 [詳解]
(void)	- setEnableVideoTrack:enable:
	メディアストリームに追加済みのビデオトラック再生状態を設定します。 [詳解]
(BOOL)	- getEnableVideoTrack:
	メディアストリームに追加済みのビデオトラック再生状態を取得します。 [詳解]
(NSUInteger)	- getAudioTracks
	メディアストリームに追加されているオーディオトラック数を取得します。 [詳解]
(void)	- setEnableAudioTrack:enable:
	メディアストリームに追加済みのオーディオトラック再生状態を設定します。 [詳解]
(BOOL)	- getEnableAudioTrack:
	メディアストリームに追加済みのオーディオトラック再生状態を取得します。 [詳解]
(BOOL)	- setCameraPosition:
	ローカル iOS デバイスのメディアストリームの場合、カメラ位置を設定します。 [詳解]
(SKWCameraPositionEnum)	- getCameraPosition
	ローカル iOS デバイスのメディアストリームオブジェクトの場合、現在のカメラ位置を取得します。 [詳解]
(BOOL)	- switchCamera
	ローカル iOS デバイスのメディアストリームの場合、使用カメラ位置を切り替えます。 [詳解]
(void)	- addVideoRenderer:track:
	このストリームにビデオレンダラーを割り当てます [詳解]
(void)	- removeVideoRenderer:track:
	このストリームに割り当てられているビデオレンダラーを取り外します [詳解]

プロパティ
NSString *__nullable	label
	メディアストリームのラベルです
NSString *__nullable	peerId
	リモートメディアストリームを所有しているピア ID です。ローカルストリームの場合は割り当てられません。

詳解

メディアストリーム

メソッド詳解

addVideoRenderer:track:

- (void) addVideoRenderer:		(SKWVideo *__nonnull)	renderer
track:		(NSUInteger)	trackNo

このストリームにビデオレンダラーを割り当てます

SKWMediaStream* stream;
SKWVideo* video;
 
[stream addVideoRenderer:video track:0];

引数

renderer	割り当てるビデオレンダラー
trackNo	トラック番号 (0 始まり)

getAudioTracks

- (NSUInteger) getAudioTracks

メディアストリームに追加されているオーディオトラック数を取得します。

SKWMediaStream* stream;
NSUInteger audios = [stream getVideoTracks];

戻り値

オーディオトラック数

getCameraPosition

- (SKWCameraPositionEnum) getCameraPosition

ローカル iOS デバイスのメディアストリームオブジェクトの場合、現在のカメラ位置を取得します。

SKWMediaStream* stream;
SKWCameraPositionEnum pos = [stream getCameraPosition];
switch (pos) {
case SKW_CAMERA_POSITION_BACK:
    // front camera
    break;
case SKW_CAMERA_POSITION_FRONT:
    // back camera
    break;
case SKW_CAMERA_POSITION_UNSPECIFIED:
    // unknown
    break;
}

戻り値

現在のカメラ位置

getEnableAudioTrack:

- (BOOL) getEnableAudioTrack:

(NSUInteger)

pos

メディアストリームに追加済みのオーディオトラック再生状態を取得します。

SKWMediaStream* stream;
BOOL enable = [stream getEnableAudioTrack:0];
if (enable) {
    // playing
} else {
    // stopped
}

引数

pos	オーディオトラック番号 (0 始まり)

戻り値

再生状態

getEnableVideoTrack:

- (BOOL) getEnableVideoTrack:

(NSUInteger)

pos

メディアストリームに追加済みのビデオトラック再生状態を取得します。

SKWMediaStream* stream;
BOOL enable = [stream getEnableVideoTrack:0];
if (enable) {
    // playing
} else {
    // stopped
}

引数

pos	ビデオトラック番号 (0 始まり)

戻り値

再生状態

getVideoTracks

- (NSUInteger) getVideoTracks

メディアストリームに追加されているビデオトラック数を取得します。

SKWMediaStream* stream;
NSUInteger videos = [stream getVideoTracks];

戻り値

ビデオトラック数

removeVideoRenderer:track:

- (void) removeVideoRenderer:		(SKWVideo *__nonnull)	renderer
track:		(NSUInteger)	trackNo

このストリームに割り当てられているビデオレンダラーを取り外します

SKWMediaStream* stream;
SKWVideo* video;
 
[stream removeVideoRenderer:video track:0];

引数

renderer	割り当て済みのビデオレンダラー
trackNo	トラック番号 (0 始まり)

setCameraPosition:

- (BOOL) setCameraPosition:

(SKWCameraPositionEnum)

pos

ローカル iOS デバイスのメディアストリームの場合、カメラ位置を設定します。

SKWMediaStream* stream;
BOOL result = [stream setCameraPosition:SKW_CAMERA_POSITION_FRONT];
if (result) {
    // successful.
} else {
    // failure.
}

引数

pos

列挙型カメラ位置

戻り値

呼び出し結果

setEnableAudioTrack:enable:

- (void) setEnableAudioTrack:		(NSUInteger)	pos
enable:		(BOOL)	enable

メディアストリームに追加済みのオーディオトラック再生状態を設定します。

SKWMediaStream* stream;
[stream setEnableAudioTrack:0 enable:YES];

引数

pos	オーディオトラック番号 (0 始まり)
enable	再生状態 enable 再生状態 YES 再生します NO 停止します

setEnableVideoTrack:enable:

- (void) setEnableVideoTrack:		(NSUInteger)	pos
enable:		(BOOL)	enable

メディアストリームに追加済みのビデオトラック再生状態を設定します。

SKWMediaStream* stream;
[stream setEnableVideoTrack:0 enable:YES];

引数

pos	ビデオトラック番号 (0 始まり)
enable	再生状態 enable 再生状態 YES 再生します NO 停止します

switchCamera

- (BOOL) switchCamera

ローカル iOS デバイスのメディアストリームの場合、使用カメラ位置を切り替えます。

SKWMediaStream* stream;
BOOL result = [stream switchCamera];
if (result) {
    // successful.
} else {
    // failure.
}

戻り値

呼び出し結果