FPWCSApi2  2.3.0
WCS iOS SDK
Class Methods
FPWCSApi2 Class Reference

#import <FPWCSApi2.h>

Inheritance diagram for FPWCSApi2:

Class Methods

(FPWCSApi2Session *) + createSession:error:
 
(FPWCSApi2RoomManager *) + createRoomManager:error:
 
(BOOL) + getMediaAccess:display:error:
 
(FPWCSApi2MediaDeviceList *) + getMediaDevices
 
(NSArray *) + getSupportedVideoResolutions
 
(FPWCSApi2Session *) + getSession:
 
(NSArray *) + getSessions
 
(BOOL) + releaseLocalMedia:
 

Detailed Description

Remarks
All work is done in separate dispatch queue that interacts with WebSockets and WebRTC.

Method Documentation

§ createRoomManager:error:()

+ (FPWCSApi2RoomManager *) createRoomManager: (FPWCSApi2RoomManagerOptions *)  options
error: (NSError **)  error 

§ createSession:error:()

+ (FPWCSApi2Session *) createSession: (FPWCSApi2SessionOptions *)  options
error: (NSError **)  error 

Create new session.

Parameters
optionsFPWCSApi2SessionOptions object with session configuration
errorNSError object to fill with info if error occurs
Returns
FPWCSApi2Session session

§ getMediaAccess:display:error:()

+ (BOOL) getMediaAccess: (FPWCSApi2MediaConstraints *)  constraints
display: (RTCEAGLVideoView *)  display
error: (NSError **)  error 

Get access to local media.

Parameters
constraintsFPWCSAPI2MediaConstraints media constraints
displayRTCEAGLVideoView View local media should be displayed in
errorNSError object to fill with info if error occurs
Returns
BOOL false if error occured otherwise true

§ getMediaDevices()

+ (FPWCSApi2MediaDeviceList *) getMediaDevices

Get local device list

Returns
FPWCSApi2MediaDeviceList device list

§ getSession:()

+ (FPWCSApi2Session *) getSession: (NSString *)  sessionID

Get session by id.

Parameters
sessionIDNSString session id
Returns
FPWCSApi2Session session

§ getSessions()

+ (NSArray *) getSessions

Get active sessions.

Returns
NSArray sessions

§ getSupportedVideoResolutions()

+ (NSArray *) getSupportedVideoResolutions

Get supported video resolutions

Returns
NSArray array with supported resolutions

§ releaseLocalMedia:()

+ (BOOL) releaseLocalMedia: (RTCEAGLVideoView *)  display

Release local media.

Returns
BOOL true if media released

The documentation for this class was generated from the following file: