vx_req_session_set_3d_position
Reference the Vivox Core SDK API.
Read time 4 minutesLast updated 8 months ago
Set and get the 3D position of the speaker and listener. More...
#include <VxcRequests.h>Public Attributes
Name | |
|---|---|
| vx_req_base_t | base The common properties for all requests. |
| VX_HANDLE | session_handle The handle returned from a successful [vx_req_sessiongroup_add_session] request. |
| double[3] | speaker_position The position of the virtual "mouth". |
| double[3] | speaker_velocity The velocity of the virtual "mouth". |
| double[3] | speaker_at_orientation This 3-vector is a unit or "direction" vector, which represents the direction or heading of the speaker. |
| double[3] | speaker_up_orientation This 3-vector is a unit or "direction" vector, which represents the "up" direction of the speaker. |
| double[3] | speaker_left_orientation This 3-vector is a unit or "direction" vector, which represents the "left" direction of the speaker. |
| double[3] | listener_position The position of the virtual "ear". |
| double[3] | listener_velocity The velocity of the virtual "ear". |
| double[3] | listener_at_orientation This 3-vector is a unit or "direction" vector, which represents the direction or "heading" of the listener. |
| double[3] | listener_up_orientation This 3-vector is a unit or "direction" vector, which represents the "up" direction of the listener. |
| double[3] | listener_left_orientation This 3-vector is a unit or "direction" vector, which represents the "left" direction of the listener. |
| orientation_type | type RESERVED FOR FUTURE USE An enum type. |
| req_disposition_type_t | req_disposition_type Control whether a response is sent back to the application for this request. |
Detailed Description
struct vx_req_session_set_3d_position;
Set and get the 3D position of the speaker and listener.
For most applications, it is expected that the speaker and listener positions are the same. The SDK also supports the decoupling of these positions (for example, for the implementation of a camera audio zoom, the virtual "mouth" is where the avatar is, and the virtual "ears" are where the camera view is).
Public Attributes Documentation
variable base
vx_req_base_t base;
The common properties for all requests.
variable session_handle
VX_HANDLE session_handle;
The handle returned from a successful [vx_req_sessiongroup_add_session] request.
variable speaker_position
double[3] speaker_position;
The position of the virtual "mouth".
This 3-vector is a right-handed Cartesian coordinate, with the positive x-axis pointing towards the speaker's right, the positive y-axis pointing up, and the positive z-axis pointing towards the speaker.
variable speaker_velocity
double[3] speaker_velocity;
The velocity of the virtual "mouth".
This 3-vector is a right-handed Cartesian coordinate, with the positive x-axis pointing towards the speaker's right, the positive y-axis pointing up, and the positive z-axis pointing towards the speaker.
variable speaker_at_orientation
double[3] speaker_at_orientation;
This 3-vector is a unit or "direction" vector, which represents the direction or heading of the speaker.
The default value is [0 0 -1] (heading "forward" or "north").
variable speaker_up_orientation
double[3] speaker_up_orientation;
This 3-vector is a unit or "direction" vector, which represents the "up" direction of the speaker.
The default value is [0 1 0].
variable speaker_left_orientation
double[3] speaker_left_orientation;
This 3-vector is a unit or "direction" vector, which represents the "left" direction of the speaker.
The default value is [-1 0 0].
variable listener_position
double[3] listener_position;
The position of the virtual "ear".
This 3-vector is a right-handed Cartesian coordinate, with the positive x-axis pointing towards the speaker's right, the positive y-axis pointing up, and the positive z-axis pointing towards the speaker.
variable listener_velocity
double[3] listener_velocity;
The velocity of the virtual "ear".
This 3-vector is a right-handed Cartesian coordinate, with the positive x-axis pointing towards the speaker's right, the positive y-axis pointing up, and the positive z-axis pointing towards the speaker.
variable listener_at_orientation
double[3] listener_at_orientation;
This 3-vector is a unit or "direction" vector, which represents the direction or "heading" of the listener.
The default value is [0 0 -1] (heading "forward" or "north").
variable listener_up_orientation
double[3] listener_up_orientation;
This 3-vector is a unit or "direction" vector, which represents the "up" direction of the listener.
The default value is [0 1 0].
variable listener_left_orientation
double[3] listener_left_orientation;
This 3-vector is a unit or "direction" vector, which represents the "left" direction of the listener.
The default value is [-1 0 0].
variable type
orientation_type type;
RESERVED FOR FUTURE USE An enum type.
The default value is 'orientation_default = 0'.
variable req_disposition_type
req_disposition_type_t req_disposition_type;
Control whether a response is sent back to the application for this request.