- Generated by
1.12.0
|
Video SDK for iOS API Reference
|
An interface to control video and manage cameras during a video session. More...
#include <ZoomVideoSDKVideoHelper.h>
Inherits NSObject.
Instance Methods | |
| (ZoomVideoSDKError) | - startVideoPreview: |
| Subscribe video raw data with a delegate. | |
| (ZoomVideoSDKError) | - startVideoPreview:resolution: |
| Subscribe to preview video raw data with a delegate. | |
| (ZoomVideoSDKError) | - stopVideoPreview: |
| UnSubscribe preview video raw data with the subscribed delegate. | |
| (ZoomVideoSDKError) | - startVideoCanvasPreview:andAspectMode: |
| Subscribe preview with a canvas view. | |
| (ZoomVideoSDKError) | - stopVideoCanvasPreview: |
| UnSubscribe preview with a canvas view. | |
| (ZoomVideoSDKError) | - startVideo |
| Call this method to start sending local video data from the camera. | |
| (ZoomVideoSDKError) | - stopVideo |
| Call this method to stop sending local video data from the camera. | |
| (BOOL) | - rotateMyVideo: |
| Call this method to rotate the video when the device is rotated. | |
| (ZoomVideoSDKError) | - mirrorMyVideo: |
| Mirrors the current user's video. | |
| (BOOL) | - isMyVideoMirrored |
| Determine whether mirror my video is enabled. | |
| (void) | - switchCamera |
| Switch to the next available camera. | |
| (NSArray< ZoomVideoSDKCameraDevice * > *_Nullable) | - getCameraDeviceList |
| Get the camera device list. | |
| (BOOL) | - switchCamera: |
| Switch camera by camera ID. | |
| (ZoomVideoSDKCameraDevice *_Nullable) | - getSelectedCamera |
| Get the current camera device in use. | |
| (ZoomVideoSDKError) | - setVideoQualityPreference: |
| Adjust user's video resolution and frame-rate. | |
| (BOOL) | - isOriginalAspectRatioEnabled |
| Determine whether current aspect ratio is the original aspect ratio of video. | |
| (BOOL) | - enableOriginalAspectRatio: |
| This function is used to set the aspect ratio of the video sent out. | |
| (BOOL) | - canEnableAlphaChannelMode |
| Determine if alpha channel mode can be enabled. | |
| (ZoomVideoSDKError) | - enableAlphaChannelMode: |
| Enable or disable video alpha channel mode. | |
| (BOOL) | - isAlphaChannelModeEnabled |
| Determine if alpha channel mode is enabled. | |
| (BOOL) | - isDeviceSupportAlphaChannelMode |
| Determines whether the device hardware capabilities are capable of supporting video alpha mode. | |
| (ZoomVideoSDKError) | - spotLightVideo: |
| Call this method to spotlight user's video. | |
| (ZoomVideoSDKError) | - unSpotLightVideo: |
| Call this method to unSpotlight user's video. | |
| (ZoomVideoSDKError) | - unSpotlightAllVideos |
| Call this method to set all user's video unSpotlight. | |
| (NSArray< ZoomVideoSDKUser * > *_Nullable) | - getSpotlightedVideoUserList |
| Call this method to get spotlighted video user list. | |
| (BOOL) | - isMultiStreamSupported |
| Determine if the current device(phone, pad) support the multi camera feature or not. | |
| (BOOL) | - enableMultiStreamVideo:customDeviceName: |
| Enable multiple video stream support if you have multiple cameras and other participants can see multiple videos of you. | |
| (BOOL) | - disableMultiStreamVideo: |
| Disable the multiple video stream. | |
| (BOOL) | - muteMultiStreamVideo: |
| Turn off the multiple video stream. | |
| (BOOL) | - unmuteMultiStreamVideo: |
| Turn on the multiple video stream. | |
| (NSString *_Nullable) | - getDeviceIDByMyPipe: |
| Get the device ID associated with my multi-camera pipe. | |
| (NSString *_Nullable) | - getDeviceIDByMyCanvas: |
| Get the device ID associated with my multi-camera canvas. | |
An interface to control video and manage cameras during a video session.
Definition at line 101 of file ZoomVideoSDKVideoHelper.h.
| - (BOOL) canEnableAlphaChannelMode |
Determine if alpha channel mode can be enabled.
| - (BOOL) disableMultiStreamVideo: | (NSString *_Nullable) | cameraDeviceID |
Disable the multiple video stream.
| cameraDeviceID | The camera ID that you want to disable. SeeZoomVideoSDKCameraDevice}. |
| - (ZoomVideoSDKError) enableAlphaChannelMode: | (BOOL) | enable |
Enable or disable video alpha channel mode.
| enable | YES indicates to enable alpha channel mode. Otherwise, disable it. |
| - (BOOL) enableMultiStreamVideo: | (NSString *_Nullable) | cameraDeviceID | |
| customDeviceName: | (NSString *_Nullable) | customDeviceName |
Enable multiple video stream support if you have multiple cameras and other participants can see multiple videos of you.
| cameraDeviceID | The camera ID for the camera to enable. SeeZoomVideoSDKCameraDevice}. |
| customDeviceName | The custom device name of the camera. If you don't pass this parameter, the SDK generates a default name. |
| - (BOOL) enableOriginalAspectRatio: | (BOOL) | enabled |
This function is used to set the aspect ratio of the video sent out.
| enabled | false means the aspect ratio is 16:9, true means that using the original aspect ratio of video. |
| - (NSArray< ZoomVideoSDKCameraDevice * > *_Nullable) getCameraDeviceList |
Get the camera device list.
| - (NSString *_Nullable) getDeviceIDByMyCanvas: | (ZoomVideoSDKVideoCanvas *_Nullable) | canvas |
Get the device ID associated with my multi-camera canvas.
| canvas | One of my multi-camera canvases. |
| - (NSString *_Nullable) getDeviceIDByMyPipe: | (ZoomVideoSDKRawDataPipe *_Nullable) | pipe |
Get the device ID associated with my multi-camera pipe.
| pipe | One of my multi-camera pipes. |
| - (ZoomVideoSDKCameraDevice *_Nullable) getSelectedCamera |
Get the current camera device in use.
| - (NSArray< ZoomVideoSDKUser * > *_Nullable) getSpotlightedVideoUserList |
Call this method to get spotlighted video user list.
| - (BOOL) isAlphaChannelModeEnabled |
Determine if alpha channel mode is enabled.
| - (BOOL) isDeviceSupportAlphaChannelMode |
Determines whether the device hardware capabilities are capable of supporting video alpha mode.
| - (BOOL) isMultiStreamSupported |
Determine if the current device(phone, pad) support the multi camera feature or not.
| - (BOOL) isMyVideoMirrored |
Determine whether mirror my video is enabled.
| - (BOOL) isOriginalAspectRatioEnabled |
Determine whether current aspect ratio is the original aspect ratio of video.
| - (ZoomVideoSDKError) mirrorMyVideo: | (BOOL) | enable |
Mirrors the current user's video.
| enable | YES to enable mirror my video, NO to reset the mirror effect back. |
| - (BOOL) muteMultiStreamVideo: | (NSString *_Nullable) | cameraDeviceID |
Turn off the multiple video stream.
| cameraDeviceID | The camera ID running as a multiple camera. SeeZoomVideoSDKCameraDevice}. |
| - (BOOL) rotateMyVideo: | (UIDeviceOrientation) | rotation |
Call this method to rotate the video when the device is rotated.
| rotation | The orientation you want to rotate. |
| - (ZoomVideoSDKError) setVideoQualityPreference: | (ZoomVideoSDKVideoPreferenceSetting *_Nullable) | preferenceSetting |
Adjust user's video resolution and frame-rate.
| preferenceSetting | An instance of ZoomVideoSDKVideoPreferenceSetting. |
| - (ZoomVideoSDKError) spotLightVideo: | (ZoomVideoSDKUser *_Nullable) | user |
Call this method to spotlight user's video.
| user | The user which you want to spotlight. |
| - (ZoomVideoSDKError) startVideo |
Call this method to start sending local video data from the camera.
| - (ZoomVideoSDKError) startVideoCanvasPreview: | (UIView *_Nullable) | view | |
| andAspectMode: | (ZoomVideoSDKVideoAspect) | aspect |
Subscribe preview with a canvas view.
| view | The view which draws the preview video. |
| aspect | The acpect mode of the preview. |
| - (ZoomVideoSDKError) startVideoPreview: | (id< ZoomVideoSDKRawDataPipeDelegate >_Nullable) | delegate |
Subscribe video raw data with a delegate.
| delegate | The delegate which receives rawdata of preview video. |
| - (ZoomVideoSDKError) startVideoPreview: | (id< ZoomVideoSDKRawDataPipeDelegate >_Nullable) | delegate | |
| resolution: | (ZoomVideoSDKVideoResolution) | resolution |
Subscribe to preview video raw data with a delegate.
| delegate | The delegate which receives rawdata of preview video. |
| resolution | Specify the resolution at which to open the camera. |
| - (ZoomVideoSDKError) stopVideo |
Call this method to stop sending local video data from the camera.
| - (ZoomVideoSDKError) stopVideoCanvasPreview: | (UIView *_Nullable) | view |
UnSubscribe preview with a canvas view.
| view | The view which draws rawdata of preview video. |
| - (ZoomVideoSDKError) stopVideoPreview: | (id< ZoomVideoSDKRawDataPipeDelegate > _Nullable) | delegate |
UnSubscribe preview video raw data with the subscribed delegate.
| delegate | The delegate which receives rawdata of preview video. |
| - (void) switchCamera |
Switch to the next available camera.
| - (BOOL) switchCamera: | (NSString *_Nullable) | cameraId |
Switch camera by camera ID.
| cameraId | The target camera ID. |
| - (BOOL) unmuteMultiStreamVideo: | (NSString *_Nullable) | cameraDeviceID |
Turn on the multiple video stream.
| cameraDeviceID | The camera ID running as a multiple camera. SeeZoomVideoSDKCameraDevice}. |
| - (ZoomVideoSDKError) unSpotlightAllVideos |
Call this method to set all user's video unSpotlight.
| - (ZoomVideoSDKError) unSpotLightVideo: | (ZoomVideoSDKUser *_Nullable) | user |
Call this method to unSpotlight user's video.
| user | The user which you want to unSpotlight. |
1.12.0