<CSVideoInterface> Protocol Reference

#import <CSVideoInterface.h>

Inherits <NSObject>.

Instance Methods
(BOOL)	- setDscp:
	This function sets DSCP value for video. More...
(BOOL)	- enableCPUAdaptiveVideo:
	Enable/Disables CPU Usage for video call(s) and control Tx/Rx. More...
(BOOL)	- registerCPUThresholdConfig:
	Registers the threshold for monitoring overriding any registered(or default) threshold values for the given threshold type. More...
(BOOL)	- unRegisterCPUThresholdConfig:
	Unregisters threshold from monitoring. More...
(BOOL)	- isThresholdAlreadyRegistered:forThreshold:
	Checks if the input threshold type was already registered for monitoring. More...
(id< CSVideoSink >)	- getLocalVideoSink:
	Retrieves a VideoSink for the specified channel. More...
(id< CSVideoSource >)	- getRemoteVideoSource:
	Retrieves a VideoSource for the specified channel. More...
(BOOL)	- isVideoreceiving:
	Returns if video packets are being received for the channel specified by the videoChannelID (only for AAC and MSS conferences). More...

Properties
id< CSVideoInterfaceDelegate >	delegate
	The delegate used to handle video-interface-related events. More...

Method Documentation

- (BOOL) enableCPUAdaptiveVideo:

(BOOL)

bEnable

Enable/Disables CPU Usage for video call(s) and control Tx/Rx.

- (id <CSVideoSink>) getLocalVideoSink:

(int)

channelId

Retrieves a VideoSink for the specified channel.

This is used to attach a Video Source (capturer).

Returns

CSVideoSink A CSVideoSink associated with the videochannel iD

Parameters

channelId

id of video channel from which to retrieve the VideoSink. It returns nil if channel does not exist or does not have a VideoSink.

- (id <CSVideoSource>) getRemoteVideoSource:

(int)

channelId

Retrieves a VideoSource for the specified channel.

This is used to attach a Video Sink (renderer).

Returns

CSVideoSource A CSVideoSource associated with the videochannel iD

Parameters

channelId

id of video channel to retrieve the VideoSource from. It returns nil if channel does not exist or does not have a VideoSource.

- (BOOL) isThresholdAlreadyRegistered:		(CSCPUThresholdType)	thresholdType
forThreshold:		(CSCPUThresholdConfiguration *)	threshold

Checks if the input threshold type was already registered for monitoring.

Returns

YES If the threshold is available and updates the values threshold argument

Parameters

thresholdType	threshold type
threshold	threshold It returns NO if no threshold was registered for thresholdType.

- (BOOL) isVideoreceiving:

(int)

channelId

Returns if video packets are being received for the channel specified by the videoChannelID (only for AAC and MSS conferences).

Returns

true If the video is receiving for the specified channel ID.

Parameters

channelId

Id of video channel to retrieve the state of video receiving from.

- (BOOL) registerCPUThresholdConfig:

(CSCPUThresholdConfiguration *)

threshold

Registers the threshold for monitoring overriding any registered(or default) threshold values for the given threshold type.

Parameters

threshold

new threshold configuration

- (BOOL) setDscp:

(int)

dscpValue

This function sets DSCP value for video.

Parameters

dscpValue

DSCP value must be in range 0-63.

Returns

YES if DSCP value is set, otherwise NO.

- (BOOL) unRegisterCPUThresholdConfig:

(CSCPUThresholdType)

thresholdType

Unregisters threshold from monitoring.

Parameters

thresholdType

threshold type

Property Documentation

- (id<CSVideoInterfaceDelegate>) delegate

readwritenonatomicweak

The delegate used to handle video-interface-related events.

---

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

• CSVideoInterface.h