SKWMediaStream Class Reference

Media stream. More...

#import <SKWMediaStream.h>

Inheritance diagram for SKWMediaStream:

Instance Methods
(void)	- close
	Close all tracks.
(NSUInteger)	- getVideoTracks
	Get video track count. More...
(void)	- setEnableVideoTrack:enable:
	Set video track enabling state. More...
(BOOL)	- getEnableVideoTrack:
	Get video track enabling state. More...
(NSUInteger)	- getAudioTracks
	Get audio track count. More...
(void)	- setEnableAudioTrack:enable:
	Set audio track enabling state. More...
(BOOL)	- getEnableAudioTrack:
	Get audio track enabling state. More...
(BOOL)	- setCameraPosition:
	Set camera position. More...
(SKWCameraPositionEnum)	- getCameraPosition
	Get camera position. More...
(BOOL)	- switchCamera
	Switch camera. More...
(void)	- addVideoRenderer:track:
(void)	- removeVideoRenderer:track:

Properties
NSString *__nullable	label
	media stream label
NSString *__nullable	peerId
	remote media stream peer id

Detailed Description

Media stream.

Method Documentation

addVideoRenderer:track:

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

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

Parameters

renderer	Video Renderer
trackNo	Track number. (0-)

getAudioTracks

- (NSUInteger) getAudioTracks

Get audio track count.

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

Returns

Count of audio track.

getCameraPosition

- (SKWCameraPositionEnum) getCameraPosition

Get camera position.

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;
}

Returns

Current camera position.

getEnableAudioTrack:

- (BOOL) getEnableAudioTrack:

(NSUInteger)

pos

Get audio track enabling state.

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

Parameters

pos	Track number.

Returns

Enabling state.

getEnableVideoTrack:

- (BOOL) getEnableVideoTrack:

(NSUInteger)

pos

Get video track enabling state.

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

Parameters

pos	Track number.

Returns

Enabling state.

getVideoTracks

- (NSUInteger) getVideoTracks

Get video track count.

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

Returns

Count of video track.

removeVideoRenderer:track:

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

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

Parameters

renderer
trackNo	Track number. (0-)

setCameraPosition:

- (BOOL) setCameraPosition:

(SKWCameraPositionEnum)

pos

Set camera position.

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

Parameters

pos	Camera position.

Returns

Method result.

setEnableAudioTrack:enable:

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

Set audio track enabling state.

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

Parameters

pos	Track number.
enable	Enabling state.

setEnableVideoTrack:enable:

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

Set video track enabling state.

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

Parameters

pos	Track number.
enable	Enabling state.

switchCamera

- (BOOL) switchCamera

Switch camera.

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

Returns

Method result.