zoom_rawdata

Zoom Raw Data
Description:
  • Zoom Raw Data
Source:
Parameters:
Name Type Description
onRawDataStatusChanged function
Returns:
Type
ZoomRawData
Description:
  • Zoom Raw Data
Source:
Parameters:
Name Type Description
onRawDataStatusChanged function
Returns:
Type
ZoomRawData

Methods

(inner) CreateRenderer(recv_handle) → {Number}

Description:
  • Create renderer.
Source:
Parameters:
Name Type Description
recv_handle Number
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) CreateRenderer(recv_handle) → {Number}

Description:
  • Create renderer.
Source:
Parameters:
Name Type Description
recv_handle Number
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) DestroyRenderer(recv_handle) → {Number}

Description:
  • Destroy renderer.
Source:
Parameters:
Name Type Description
recv_handle Number
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) DestroyRenderer(recv_handle) → {Number}

Description:
  • Destroy renderer.
Source:
Parameters:
Name Type Description
recv_handle Number
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) GetRawDataType(recv_handle) → {Number}

Description:
  • Get raw data type.
Source:
Parameters:
Name Type Description
recv_handle Number
Returns:
ZoomSDKRawDataType
Type
Number

(inner) GetRawDataType(recv_handle) → {Number}

Description:
  • Get raw data type.
Source:
Parameters:
Name Type Description
recv_handle Number
Returns:
ZoomSDKRawDataType
Type
Number

(inner) GetResolution(recv_handle) → {Number}

Description:
  • Get raw data resolution.
Source:
Parameters:
Name Type Description
recv_handle Number
Returns:
RawDataResolution
Type
Number

(inner) GetResolution(recv_handle) → {Number}

Description:
  • Get raw data resolution.
Source:
Parameters:
Name Type Description
recv_handle Number
Returns:
RawDataResolution
Type
Number

(inner) GetSubscribeId(recv_handle) → {Number}

Description:
  • Get the subscribed ID specified when subscribing.
Source:
Parameters:
Name Type Description
recv_handle Number
Returns:
subscribed id.
Type
Number

(inner) GetSubscribeId(recv_handle) → {Number}

Description:
  • Get the subscribed ID specified when subscribing.
Source:
Parameters:
Name Type Description
recv_handle Number
Returns:
subscribed id.
Type
Number

(inner) HasRawDataLicense() → {Boolean}

Description:
  • Check if raw data license is available.
Source:
Returns:
true or false
Type
Boolean

(inner) HasRawDataLicense() → {Boolean}

Description:
  • Check if raw data license is available.
Source:
Returns:
true or false
Type
Boolean

(inner) InitAudioRawDataHelper() → {Number}

Description:
  • Initialize audio raw data helper.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) InitAudioRawDataHelper() → {Number}

Description:
  • Initialize audio raw data helper.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) SetRawDataResolution(resolution, recv_handle) → {Number}

Description:
  • Set raw data resolution.
Source:
Parameters:
Name Type Description
resolution Number Specify the raw data resolution ZoomSDKResolution
recv_handle Number
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) SetRawDataResolution(resolution, recv_handle) → {Number}

Description:
  • Set raw data resolution.
Source:
Parameters:
Name Type Description
resolution Number Specify the raw data resolution ZoomSDKResolution
recv_handle Number
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) SetonRawDataStatusChangedCB(onRawDataStatusChanged) → {Boolean}

Description:
  • Set onRawDataStatusChanged callback.
Source:
Parameters:
Name Type Description
onRawDataStatusChanged function
Returns:
true or false
Type
Boolean

(inner) SetonRawDataStatusChangedCB(onRawDataStatusChanged) → {Boolean}

Description:
  • Set onRawDataStatusChanged callback.
Source:
Parameters:
Name Type Description
onRawDataStatusChanged function
Returns:
true or false
Type
Boolean

(inner) Subscribe(subscribeId, rawdataType, recv_handle) → {Number}

Description:
  • Subscribe to the video or share's raw data.
Source:
Parameters:
Name Type Description
subscribeId Number If 'type' is RAW_DATA_TYPE_VIDEO, 'subscribeId' refers to the user ID, otherwise it refers to the shared source ID of user.
rawdataType Number Specify the raw data type ZoomSDKRawDataType
recv_handle Number
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) Subscribe(subscribeId, rawdataType, recv_handle) → {Number}

Description:
  • Subscribe to the video or share's raw data.
Source:
Parameters:
Name Type Description
subscribeId Number If 'type' is RAW_DATA_TYPE_VIDEO, 'subscribeId' refers to the user ID, otherwise it refers to the shared source ID of user.
rawdataType Number Specify the raw data type ZoomSDKRawDataType
recv_handle Number
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) SubscribeAudioRawdata() → {Number}

Description:
  • Subscribe to audio raw data.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) SubscribeAudioRawdata() → {Number}

Description:
  • Subscribe to audio raw data.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) UnSubscribe(recv_handle) → {Number}

Description:
  • Unsubscribe from the video or share's raw data.
Source:
Parameters:
Name Type Description
recv_handle Number
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) UnSubscribe(recv_handle) → {Number}

Description:
  • Unsubscribe from the video or share's raw data.
Source:
Parameters:
Name Type Description
recv_handle Number
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) UnSubscribeAudioRawdata() → {Number}

Description:
  • Unsubscribe from audio raw data.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) UnSubscribeAudioRawdata() → {Number}

Description:
  • Unsubscribe from audio raw data.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

Events

onRawDataStatusChanged

Description:
  • onRawDataStatusChanged callback
Source:
Parameters:
Name Type Description
status Number RawDataStatus
recv_handle Number

onRawDataStatusChanged

Description:
  • onRawDataStatusChanged callback
Source:
Parameters:
Name Type Description
status Number RawDataStatus
recv_handle Number
Zoom Raw Data
Description:
  • Zoom Raw Data
Source:
Parameters:
Name Type Description
onRawDataStatusChanged function
Returns:
Type
ZoomRawData
Description:
  • Zoom Raw Data
Source:
Parameters:
Name Type Description
onRawDataStatusChanged function
Returns:
Type
ZoomRawData

Methods

(inner) CreateRenderer(recv_handle) → {Number}

Description:
  • Create renderer.
Source:
Parameters:
Name Type Description
recv_handle Number
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) CreateRenderer(recv_handle) → {Number}

Description:
  • Create renderer.
Source:
Parameters:
Name Type Description
recv_handle Number
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) DestroyRenderer(recv_handle) → {Number}

Description:
  • Destroy renderer.
Source:
Parameters:
Name Type Description
recv_handle Number
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) DestroyRenderer(recv_handle) → {Number}

Description:
  • Destroy renderer.
Source:
Parameters:
Name Type Description
recv_handle Number
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) GetRawDataType(recv_handle) → {Number}

Description:
  • Get raw data type.
Source:
Parameters:
Name Type Description
recv_handle Number
Returns:
ZoomSDKRawDataType
Type
Number

(inner) GetRawDataType(recv_handle) → {Number}

Description:
  • Get raw data type.
Source:
Parameters:
Name Type Description
recv_handle Number
Returns:
ZoomSDKRawDataType
Type
Number

(inner) GetResolution(recv_handle) → {Number}

Description:
  • Get raw data resolution.
Source:
Parameters:
Name Type Description
recv_handle Number
Returns:
RawDataResolution
Type
Number

(inner) GetResolution(recv_handle) → {Number}

Description:
  • Get raw data resolution.
Source:
Parameters:
Name Type Description
recv_handle Number
Returns:
RawDataResolution
Type
Number

(inner) GetSubscribeId(recv_handle) → {Number}

Description:
  • Get the subscribed ID specified when subscribing.
Source:
Parameters:
Name Type Description
recv_handle Number
Returns:
subscribed id.
Type
Number

(inner) GetSubscribeId(recv_handle) → {Number}

Description:
  • Get the subscribed ID specified when subscribing.
Source:
Parameters:
Name Type Description
recv_handle Number
Returns:
subscribed id.
Type
Number

(inner) HasRawDataLicense() → {Boolean}

Description:
  • Check if raw data license is available.
Source:
Returns:
true or false
Type
Boolean

(inner) HasRawDataLicense() → {Boolean}

Description:
  • Check if raw data license is available.
Source:
Returns:
true or false
Type
Boolean

(inner) InitAudioRawDataHelper() → {Number}

Description:
  • Initialize audio raw data helper.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) InitAudioRawDataHelper() → {Number}

Description:
  • Initialize audio raw data helper.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) SetRawDataResolution(resolution, recv_handle) → {Number}

Description:
  • Set raw data resolution.
Source:
Parameters:
Name Type Description
resolution Number Specify the raw data resolution ZoomSDKResolution
recv_handle Number
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) SetRawDataResolution(resolution, recv_handle) → {Number}

Description:
  • Set raw data resolution.
Source:
Parameters:
Name Type Description
resolution Number Specify the raw data resolution ZoomSDKResolution
recv_handle Number
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) SetonRawDataStatusChangedCB(onRawDataStatusChanged) → {Boolean}

Description:
  • Set onRawDataStatusChanged callback.
Source:
Parameters:
Name Type Description
onRawDataStatusChanged function
Returns:
true or false
Type
Boolean

(inner) SetonRawDataStatusChangedCB(onRawDataStatusChanged) → {Boolean}

Description:
  • Set onRawDataStatusChanged callback.
Source:
Parameters:
Name Type Description
onRawDataStatusChanged function
Returns:
true or false
Type
Boolean

(inner) Subscribe(subscribeId, rawdataType, recv_handle) → {Number}

Description:
  • Subscribe to the video or share's raw data.
Source:
Parameters:
Name Type Description
subscribeId Number If 'type' is RAW_DATA_TYPE_VIDEO, 'subscribeId' refers to the user ID, otherwise it refers to the shared source ID of user.
rawdataType Number Specify the raw data type ZoomSDKRawDataType
recv_handle Number
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) Subscribe(subscribeId, rawdataType, recv_handle) → {Number}

Description:
  • Subscribe to the video or share's raw data.
Source:
Parameters:
Name Type Description
subscribeId Number If 'type' is RAW_DATA_TYPE_VIDEO, 'subscribeId' refers to the user ID, otherwise it refers to the shared source ID of user.
rawdataType Number Specify the raw data type ZoomSDKRawDataType
recv_handle Number
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) SubscribeAudioRawdata() → {Number}

Description:
  • Subscribe to audio raw data.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) SubscribeAudioRawdata() → {Number}

Description:
  • Subscribe to audio raw data.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) UnSubscribe(recv_handle) → {Number}

Description:
  • Unsubscribe from the video or share's raw data.
Source:
Parameters:
Name Type Description
recv_handle Number
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) UnSubscribe(recv_handle) → {Number}

Description:
  • Unsubscribe from the video or share's raw data.
Source:
Parameters:
Name Type Description
recv_handle Number
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) UnSubscribeAudioRawdata() → {Number}

Description:
  • Unsubscribe from audio raw data.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) UnSubscribeAudioRawdata() → {Number}

Description:
  • Unsubscribe from audio raw data.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

Events

onRawDataStatusChanged

Description:
  • onRawDataStatusChanged callback
Source:
Parameters:
Name Type Description
status Number RawDataStatus
recv_handle Number

onRawDataStatusChanged

Description:
  • onRawDataStatusChanged callback
Source:
Parameters:
Name Type Description
status Number RawDataStatus
recv_handle Number