vx_req_session_media_connect
Reference the Vivox Core SDK API.
Read time 2 minutesLast updated a day ago
Module: Group Voice and Text Communications Connect media (audio) in a session. More...
#include <VxcRequests.h>Public Attributes
Name | |
|---|---|
| vx_req_base_t | base The common properties for all requests. |
| VX_HANDLE | sessiongroup_handle |
| VX_HANDLE | session_handle Returned from a successful [vx_req_sessiongroup_add_session] request. |
| int | session_font_id The ID of the voice font to apply to the session. |
| vx_media_type | media |
| char * | capture_device_id |
| char * | render_device_id |
| int | jitter_compensation The jitter buffer compensation for the SIP session. |
| int | loop_mode_duration_seconds The number of seconds of audio to keep on the client. |
Detailed Description
Connect media (audio) in a session. See: vx_resp_session_media_connect Note: To use this request, a session must have already been created with media disconnected.struct vx_req_session_media_connect;
Public Attributes Documentation
variable base
The common properties for all requests.vx_req_base_t base;
variable sessiongroup_handle
Deprecated: Do not use. This structure member is ignored.VX_HANDLE sessiongroup_handle;
variable session_handle
Returned from a successful [vx_req_sessiongroup_add_session] request.VX_HANDLE session_handle;
variable session_font_id
The ID of the voice font to apply to the session. You can obtain a list of available voice font IDs with vx_req_account_get_session_fonts. Set to 0 for none.int session_font_id;
variable media
Deprecated: This is deprecated and should not be used.vx_media_type media;
variable capture_device_id
Deprecated: Use vx_req_aux_set_capture_device to set the capture device instead. The device ID of the capture device to use. Use NULL or empty to use the last selected capture device.char * capture_device_id;
variable render_device_id
Deprecated: Use vx_req_aux_set_render_device to set the capture device instead. The device ID of the render device to use. Use NULL or empty to use the last selected render device.char * render_device_id;
variable jitter_compensation
The jitter buffer compensation for the SIP session. This integer value represents the amount of compensation in milliseconds (ms) to apply to counteract network jitter. Valid values are 1-150 ms. If this field is not initialized, or if it is set to 1, then the SDK applies the default values for the given type of session.int jitter_compensation;
variable loop_mode_duration_seconds
The number of seconds of audio to keep on the client. This creates a feature similar to a DVR, but for audio. For applications that need delayed playback, this is the number of seconds of historical conversation that is kept (relative to now). If loop mode is not needed, then set this to zero. The default value is 0.int loop_mode_duration_seconds;