vx_req_sessiongroup_add_session#

Sessions represent a connection to a media session with one or more participants. More...

#include <VxcRequests.h>

Public Attributes#

Detailed Description#

struct vx_req_sessiongroup_add_session;

Sessions represent a connection to a media session with one or more participants.

See: vx_resp_sessiongroup_add_session

Sessions can be connected to session audio, text chat, or both session audio and text chat.

Public Attributes Documentation#

variable base#

vx_req_base_t base;

The common properties for all requests.

variable sessiongroup_handle#

VX_HANDLE sessiongroup_handle;

The preferred session group handle.

Attention: This cannot match any existing handle (for example, account_handle or session_handle), but can be an existing sessiongroup_handle. This is a string. This must include at least one non-numeric character. If this is empty, then a handle is automatically generated.

variable uri#

char * uri;

The URI of the terminating point of the session (who or what is being called).

URIs must be valid, and URI length cannot exceed MAX_CHANNEL_URI_LENGTH. Characters must use the following criteria:

• Valid alphanumeric characters: abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890
• Valid non-alphanumeric characters: -_.!~*'()&=+$,;?/
• Escape sequence: Percent (%) followed by two hex characters (0-9 or A-F), which represent the ASCII value of the character that is being encoded. For example:
  • 1. space - %20
  • 1. @ - %40
  • 1. : - %3A

variable name#

char * name;

Deprecated:

This is deprecated and should not be used. The display name of the entity being called (user or channel).

variable password#

char * password;

Deprecated:

This is deprecated and should not be used. The password that is used if the user is joining a password-protected channel.

variable connect_audio#

int connect_audio;

Determines whether the session will connect to session audio.

• 1 indicates that the session will connect to session audio.
• 0 indicates that the session will not connect to session audio. The default value is 0.

variable password_hash_algorithm#

vx_password_hash_algorithm_t password_hash_algorithm;

Deprecated:

This is deprecated and should not be used. Indicates the hashing algorithm used on the password that is passed in to the SDK. This can be password_hash_algorithm_cleartext or password_hash_algorithm_sha1_username_hash.

• For password_hash_algorithm_cleartext, the password that is passed in is in cleartext.
• For password_hash_algorithm_sha1_username_hash, the password that is passed in is the SHA1 hash of the password and the SIP URI of the user, Base64-encoded, with any trailing '=' characters stripped off.

variable session_font_id#

int session_font_id;

Deprecated:

This is deprecated and should not be used. 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.

variable connect_text#

int connect_text;

Determine whether the session will connect to text chat.

• 1 indicates that the session will connect to text chat.
• 0 indicates that the session will not connect to text chat. The default value is 0.

variable jitter_compensation#

int 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.

variable session_handle#

char * session_handle;

The preferred session 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.

variable access_token#

char * access_token;

A Vivox Access Token that is used to authorize the operation.

For more information, see the Access Token Developer Guide.

variable account_handle#

VX_HANDLE account_handle;

The account handle used in the vx_req_account_anonymous_login request.

Note: V5 only. This is ignored by V4.

A user must be logged in to create a session. When a player logs out, all sessions are destroyed.