vx_req_sessiongroup_create
Reference the Vivox Core SDK API.
Read time 1 minuteLast updated 7 months ago
#include <VxcRequests.h>Public Attributes
Name | |
|---|---|
| vx_req_base_t | base The common properties for all requests. |
| VX_HANDLE | account_handle The handle returned from a successful vx_req_account_anonymous_login request. |
| vx_sessiongroup_type | type The session group type. |
| int | loop_mode_duration_seconds The number of seconds of audio to keep on the client. |
| char * | capture_device_id |
| char * | render_device_id |
| char * | alias_username |
| char * | sessiongroup_handle The preferred session group handle. |
Detailed Description
struct vx_req_sessiongroup_create;
Note: A session group handle is required to change these aspects within the session group. If the session create command is used, a session group is automatically created.
Public Attributes Documentation
variable base
vx_req_base_t base;
The common properties for all requests.
variable account_handle
VX_HANDLE account_handle;
The handle returned from a successful vx_req_account_anonymous_login request.
variable type
vx_sessiongroup_type type;
The session group type.
See: vx_sessiongroup_type
variable loop_mode_duration_seconds
int 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.
variable capture_device_id
char * capture_device_id;
Deprecated:
This field is ignored.
variable render_device_id
char * render_device_id;
Deprecated:
This field is ignored.
variable alias_username
char * alias_username;
Deprecated:
This field is deprecated and should not be used.
variable sessiongroup_handle
char * sessiongroup_handle;
The preferred session group handle.
Attention: This cannot match any existing handle (for example, account_handle or session_handle). This is a string. This must include at least one non-numeric character. If this is empty, then a handle is automatically generated.