SIP Endpoint SDK for OS X
 All Classes Functions Properties
<GSVideoService> Protocol Reference

#import <Services.h>

Inheritance diagram for <GSVideoService>:
GSDefaultVideoService

List of all members.

Public Member Functions

(GSStatus) - pauseVideoCapture
(GSStatus) - resumeVideoCapture
(GSVideoState) - videoCaptureState
(GSResult) - stopVideoCapture
(GSResult) - startVideoCaptureWithCapability:
(GSResult) - startLocalVideoStream:withCapability:
(GSResult) - changeLocalVideoStream:
(GSResult) - startRemoteVideoForSession:withConfiguration:
(GSResult) - changeRemoteVideoForSession:withConfiguration:
(GSResult) - stopLocalVideo
(GSResult) - stopRemoteVideoForSession:

Properties

BOOL isLocalVideoStarted
BOOL isRemoteVideoStarted
GSVideoState captureState

Detailed Description

Video service protocol

Definition at line 324 of file Services.h.


Member Function Documentation

- (GSResult) changeLocalVideoStream: (GSVideoStream *)  stream

Change the local video stream settings

Parameters:
streamthe video stream settings.
Returns:
the result of the operation.
See also:
GSVideoStream
- (GSResult) changeRemoteVideoForSession: (id< GSSession >)  session
withConfiguration: (GSVideoStream *)  stream 

Change the remote video for the session with new video stream settings

Parameters:
sessionobject.
streamthe video stream settings.
Returns:
the result of the operation.
See also:
GSSession, GSVideoStream
- (GSStatus) pauseVideoCapture

Pause the current video capture

Returns:
the result of the operation.
- (GSStatus) resumeVideoCapture

Resume the current video capture

Returns:
the result of the operation.
- (GSResult) startLocalVideoStream: (GSVideoStream *)  stream
withCapability: (GSCaptureCapability *)  capability 

Starts a local video with video stream settings

Parameters:
streamthe video stream settings.
Returns:
the result of the operation.
See also:
GSVideoStream
- (GSResult) startRemoteVideoForSession: (id< GSSession >)  session
withConfiguration: (GSVideoStream *)  stream 

Starts a remote video for the session with video stream settings

Parameters:
sessionobject.
streamthe video stream settings.
Returns:
the result of the operation.
See also:
GSSession, GSVideoStream
- (GSResult) startVideoCaptureWithCapability: (GSCaptureCapability *)  capability

Starts local video capture with capability

Parameters:
capabilityitem at index 0: represent width (int) item at index 1: represent height (int) item at index 2: represent frame per second (int) item at index 3: represent video_render_format (int) i420 = 0, YV12 = 1, YUY2 = 2, UYVY = 3, IYUV = 4, ARGB = 5, RGB24 = 6, RGB565 = 7, ARGB4444 = 8, ARGB1555 = 9, MJPEG = 10, NV12 = 11, NV21 = 12, BGRA = 13, unknown = 99
Returns:
the result of the operation.
- (GSResult) stopLocalVideo

Stops the current local video

Returns:
the result of the operation.
- (GSResult) stopRemoteVideoForSession: (id< GSSession >)  session

Stops the remote video for the session

Parameters:
sessionobject.
Returns:
the result of the operation.
See also:
GSSession
- (GSResult) stopVideoCapture

Stop local video capture

Returns:
the result of the operation.
- (GSVideoState) videoCaptureState

Get the current video capture state

Returns:
the state of the current video capture.
See also:
GSVideoState

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