vx_req_aux_render_audio_start
Learn about audio management.
Read time 1 minuteLast updated 20 hours ago
Module: Audio Devices Ensure that a specific selected render device is functioning properly. More...
#include <VxcRequests.h>Public Attributes
Name | |
|---|---|
| vx_req_base_t | base The common properties for all requests. |
| char * | sound_file_path A local directory path name of a monaural .wav or .au sound file. |
| int | loop If set to 1, the sound system plays the file in a continuous loop until the "render audio stop" method is called. |
| char * | path |
| VX_HANDLE | account_handle An optional parameter that specifies the account handle of the user whose render device will be used. |
Detailed Description
Ensure that a specific selected render device is functioning properly. See: vx_resp_aux_render_audio_start The sound_file_path should point to a local directory path that contains a monaural .wav or .au sound file. If the loop value is set to 1, then the sound system plays the file in a continuous loop until the "render audio stop" method is called.struct vx_req_aux_render_audio_start;
Public Attributes Documentation
variable base
The common properties for all requests.vx_req_base_t base;
variable sound_file_path
A local directory path name of a monaural .wav or .au sound file.char * sound_file_path;
variable loop
If set to 1, the sound system plays the file in a continuous loop until the "render audio stop" method is called. If set to 0, the file plays once or until the "render audio stop" method is called. The default value is 0.int loop;
variable path
Deprecated: Debug use only.char * path;
variable account_handle
An optional parameter that specifies the account handle of the user whose render device will be used. This must either be unset or the account_handle that was passed in to a vx_req_account_anonymous_login request that previously succeeded. If unset, the default account_handle is used.VX_HANDLE account_handle;