CRI ADX
Last Updated: 2024-07-17 10:47 p
|
Data Structures | |
struct | CriAtomExSourceInfoTag |
Playback source information. More... | |
struct | CriAtomExPlaybackInfoDetailTag |
Playback information details. More... | |
Macros | |
#define | CRIATOMEX_INVALID_PLAYBACK_ID (0xFFFFFFFF) |
Invalid playback ID. More... | |
#define | CRIATOMEX_INVALID_BLOCK_INDEX (0xFFFFFFFF) |
Invalid Block Index. More... | |
Typedefs | |
typedef enum CriAtomExPlaybackStatusTag | CriAtomExPlaybackStatus |
Playback status. More... | |
typedef enum CriAtomExSourceTypeTag | CriAtomExSourceType |
Playback source type. More... | |
typedef struct CriAtomExSourceInfoTag | CriAtomExSourceInfo |
Playback source information. More... | |
typedef enum CriAtomExPlaybackEventTag | CriAtomExPlaybackEvent |
Playback Event. More... | |
typedef struct CriAtomExPlaybackInfoDetailTag | CriAtomExPlaybackInfoDetail |
Playback information details. More... | |
typedef void(* | CriAtomExPlaybackEventCbFunc) (void *obj, CriAtomExPlaybackEvent playback_event, const CriAtomExPlaybackInfoDetail *info) |
Replay event callback function type. More... | |
Functions | |
void | criAtomExPlayback_Stop (CriAtomExPlaybackId id) |
Stop the sound. More... | |
void | criAtomExPlayback_StopWithoutReleaseTime (CriAtomExPlaybackId id) |
Stop the sound (ignoring the release time) More... | |
void | criAtomExPlayback_Pause (CriAtomExPlaybackId id, CriBool sw) |
Pause/resume the sound. More... | |
void | criAtomExPlayback_Resume (CriAtomExPlaybackId id, CriAtomExResumeMode mode) |
Resume the audio playback (paused by a specific pause method) More... | |
CriBool | criAtomExPlayback_IsPaused (CriAtomExPlaybackId id) |
Get the pause status of the sound. More... | |
CriAtomExPlaybackStatus | criAtomExPlayback_GetStatus (CriAtomExPlaybackId id) |
Get the playback status. More... | |
CriBool | criAtomExPlayback_GetFormatInfo (CriAtomExPlaybackId id, CriAtomExFormatInfo *info) |
Get information about the format of the sound being played. More... | |
CriBool | criAtomExPlayback_GetSource (CriAtomExPlaybackId id, CriAtomExSourceInfo *source) |
Get information about the source of the sound. More... | |
CriAtomPlayerHn | criAtomExPlayback_GetAtomPlayer (CriAtomExPlaybackId id) |
Acquisition of an Atom player. More... | |
CriSint64 | criAtomExPlayback_GetTime (CriAtomExPlaybackId id) |
Get the playback time. More... | |
CriSint64 | criAtomExPlayback_GetTimeSyncedWithAudio (CriAtomExPlaybackId id) |
Get the playback time (synchronized with playback sound) More... | |
CriSint64 | criAtomExPlayback_GetTimeSyncedWithAudioMicro (CriAtomExPlaybackId id) |
Get the playback time (synchronized with playback sound) More... | |
CriSint64 | criAtomExPlayback_GetSequencePosition (CriAtomExPlaybackId id) |
Acquiring the sequence playback position. More... | |
CriBool | criAtomExPlayback_GetNumPlayedSamples (CriAtomExPlaybackId id, CriSint64 *num_samples, CriSint32 *sampling_rate) |
Get the number of samples played. More... | |
CriBool | criAtomExPlayback_GetNumRenderedSamples (CriAtomExPlaybackId id, CriSint64 *num_samples, CriSint32 *sampling_rate) |
Get the number of samples to write to the sound buffer. More... | |
CriBool | criAtomExPlayback_GetParameterFloat32 (CriAtomExPlaybackId playback_id, CriAtomExParameterId parameter_id, CriFloat32 *value_float32) |
Get a parameter (floating point number) More... | |
CriBool | criAtomExPlayback_GetParameterUint32 (CriAtomExPlaybackId playback_id, CriAtomExParameterId parameter_id, CriUint32 *value_uint32) |
Get a parameter (unsigned integer) More... | |
CriBool | criAtomExPlayback_GetParameterSint32 (CriAtomExPlaybackId playback_id, CriAtomExParameterId parameter_id, CriSint32 *value_sint32) |
Get a parameter (signed integer) More... | |
CriBool | criAtomExPlayback_GetAisacControlById (CriAtomExPlaybackId playback_id, CriAtomExAisacControlId control_id, CriFloat32 *control_value) |
Get the value of an AISAC control (specified by its ID) More... | |
CriBool | criAtomExPlayback_GetAisacControlByName (CriAtomExPlaybackId playback_id, const CriChar8 *control_name, CriFloat32 *control_value) |
Get the value of an AISAC control (specified by its name) More... | |
void | criAtomExPlayback_SetNextBlockIndex (CriAtomExPlaybackId id, CriAtomExBlockIndex index) |
Set the index of the next block. More... | |
CriAtomExBlockIndex | criAtomExPlayback_GetCurrentBlockIndex (CriAtomExPlaybackId id) |
Get the current block index of the sound beng played back. More... | |
CriBool | criAtomExPlayback_GetPlaybackTrackInfo (CriAtomExPlaybackId id, CriAtomExPlaybackTrackInfo *info) |
Get the playback track info. More... | |
CriBool | criAtomExPlayback_GetBeatSyncInfo (CriAtomExPlaybackId id, CriAtomExBeatSyncInfo *info) |
Get the beat synchronization information. More... | |
CriBool | criAtomExPlayback_SetBeatSyncOffset (CriAtomExPlaybackId id, CriSint16 time_ms) |
Beat sync offset setting. More... | |
#define CRIATOMEX_INVALID_PLAYBACK_ID (0xFFFFFFFF) |
Invalid playback ID.
#define CRIATOMEX_INVALID_BLOCK_INDEX (0xFFFFFFFF) |
Invalid Block Index.
typedef enum CriAtomExPlaybackStatusTag CriAtomExPlaybackStatus |
Playback status.
typedef enum CriAtomExSourceTypeTag CriAtomExSourceType |
Playback source type.
typedef struct CriAtomExSourceInfoTag CriAtomExSourceInfo |
Playback source information.
typedef enum CriAtomExPlaybackEventTag CriAtomExPlaybackEvent |
Playback Event.
typedef struct CriAtomExPlaybackInfoDetailTag CriAtomExPlaybackInfoDetail |
Playback information details.
typedef void( * CriAtomExPlaybackEventCbFunc) (void *obj, CriAtomExPlaybackEvent playback_event, const CriAtomExPlaybackInfoDetail *info) |
Replay event callback function type.
[in] | obj | User specified object |
[in] | playback_event | Playback Event |
[in] | info | Information |
Playback status.
Enumerator | |
---|---|
CRIATOMEXPLAYBACK_STATUS_PREP | In preparation for playback |
CRIATOMEXPLAYBACK_STATUS_PLAYING | In playback |
CRIATOMEXPLAYBACK_STATUS_REMOVED | Removed |
Playback source type.
Playback Event.
Enumerator | |
---|---|
CRIATOMEX_PLAYBACK_EVENT_ALLOCATE | Allocating new playback resources.
|
CRIATOMEX_PLAYBACK_EVENT_FROM_VIRTUAL_TO_NORMAL | Voice assignment.
|
CRIATOMEX_PLAYBACK_EVENT_FROM_NORMAL_TO_VIRTUAL | Virtualization.
|
CRIATOMEX_PLAYBACK_EVENT_REMOVE | Releasing playback resources.
|
void criAtomExPlayback_Stop | ( | CriAtomExPlaybackId | id | ) |
Stop the sound.
[in] | id | playback ID |
void criAtomExPlayback_StopWithoutReleaseTime | ( | CriAtomExPlaybackId | id | ) |
Stop the sound (ignoring the release time)
[in] | id | playback ID |
void criAtomExPlayback_Pause | ( | CriAtomExPlaybackId | id, |
CriBool | sw | ||
) |
Pause/resume the sound.
[in] | id | playback ID |
[in] | sw | switch ( CRI_FALSE = resume, CRI_TRUE = pause ) |
void criAtomExPlayback_Resume | ( | CriAtomExPlaybackId | id, |
CriAtomExResumeMode | mode | ||
) |
Resume the audio playback (paused by a specific pause method)
[in] | id | playback ID |
[in] | mode | resume target |
CriBool criAtomExPlayback_IsPaused | ( | CriAtomExPlaybackId | id | ) |
Get the pause status of the sound.
[in] | id | playback ID |
CriAtomExPlaybackStatus criAtomExPlayback_GetStatus | ( | CriAtomExPlaybackId | id | ) |
Get the playback status.
[in] | id | playback ID |
So, regardless of whether the sound was explicitly stopped using the criAtomExPlayback_Stop function or its playback was stopped due to other factors, its status changes to CRIATOMEXPLAYBACK_STATUS_REMOVED .
(Consequently, if you need to know if there was an error, you must use the criAtomExPlayer_GetStatus function instead of this function to check the status of the AtomEx player itself.)
CriBool criAtomExPlayback_GetFormatInfo | ( | CriAtomExPlaybackId | id, |
CriAtomExFormatInfo * | info | ||
) |
Get information about the format of the sound being played.
[in] | id | playback ID |
[out] | info | format information |
CriBool criAtomExPlayback_GetSource | ( | CriAtomExPlaybackId | id, |
CriAtomExSourceInfo * | source | ||
) |
Get information about the source of the sound.
[in] | id | playback ID |
[out] | source | source information |
CRI_TRUE | = information was successfully retrieved |
CRI_FALSE | = failed to get information |
CriAtomPlayerHn criAtomExPlayback_GetAtomPlayer | ( | CriAtomExPlaybackId | id | ) |
Acquisition of an Atom player.
[in] | id | Playback ID |
CriAtomPlayerHn | Atom player handle |
CriSint64 criAtomExPlayback_GetTime | ( | CriAtomExPlaybackId | id | ) |
Get the playback time.
[in] | id | playback ID |
CriSint64 criAtomExPlayback_GetTimeSyncedWithAudio | ( | CriAtomExPlaybackId | id | ) |
Get the playback time (synchronized with playback sound)
[in] | id | playback ID |
CriSint64 criAtomExPlayback_GetTimeSyncedWithAudioMicro | ( | CriAtomExPlaybackId | id | ) |
Get the playback time (synchronized with playback sound)
[in] | id | playback ID |
CriSint64 criAtomExPlayback_GetSequencePosition | ( | CriAtomExPlaybackId | id | ) |
Acquiring the sequence playback position.
[in] | id | Playback ID |
CriBool criAtomExPlayback_GetNumPlayedSamples | ( | CriAtomExPlaybackId | id, |
CriSint64 * | num_samples, | ||
CriSint32 * | sampling_rate | ||
) |
Get the number of samples played.
[in] | id | playback ID |
[out] | num_samples | the number of samples already played back |
[out] | sampling_rate | sampling rate |
CriBool criAtomExPlayback_GetNumRenderedSamples | ( | CriAtomExPlaybackId | id, |
CriSint64 * | num_samples, | ||
CriSint32 * | sampling_rate | ||
) |
Get the number of samples to write to the sound buffer.
[in] | id | playback ID |
[out] | num_samples | Number of written samples (in units of sample) |
[out] | sampling_rate | Sampling rate (in Hz) |
CriBool criAtomExPlayback_GetParameterFloat32 | ( | CriAtomExPlaybackId | playback_id, |
CriAtomExParameterId | parameter_id, | ||
CriFloat32 * | value_float32 | ||
) |
Get a parameter (floating point number)
[in] | playback_id | playback ID |
[in] | parameter_id | parameter ID |
[out] | value_float32 | parameter value |
CriBool criAtomExPlayback_GetParameterUint32 | ( | CriAtomExPlaybackId | playback_id, |
CriAtomExParameterId | parameter_id, | ||
CriUint32 * | value_uint32 | ||
) |
Get a parameter (unsigned integer)
[in] | playback_id | playback ID |
[in] | parameter_id | parameter ID |
[out] | value_uint32 | parameter value |
CriBool criAtomExPlayback_GetParameterSint32 | ( | CriAtomExPlaybackId | playback_id, |
CriAtomExParameterId | parameter_id, | ||
CriSint32 * | value_sint32 | ||
) |
Get a parameter (signed integer)
[in] | playback_id | playback ID |
[in] | parameter_id | parameter ID |
[out] | value_sint32 | parameter value |
CriBool criAtomExPlayback_GetAisacControlById | ( | CriAtomExPlaybackId | playback_id, |
CriAtomExAisacControlId | control_id, | ||
CriFloat32 * | control_value | ||
) |
Get the value of an AISAC control (specified by its ID)
[in] | playback_id | playback ID |
[in] | control_id | control ID |
[out] | control_value | control value (from 0.0f to 1.0f, -1.0f if not set) |
CriBool criAtomExPlayback_GetAisacControlByName | ( | CriAtomExPlaybackId | playback_id, |
const CriChar8 * | control_name, | ||
CriFloat32 * | control_value | ||
) |
Get the value of an AISAC control (specified by its name)
[in] | playback_id | playback ID |
[in] | control_name | control name |
[out] | control_value | control value (0.0f to 1.0f. If not set, -1.0f.) |
void criAtomExPlayback_SetNextBlockIndex | ( | CriAtomExPlaybackId | id, |
CriAtomExBlockIndex | index | ||
) |
Set the index of the next block.
[in] | id | playback ID |
[in] | index | block index |
CriAtomExBlockIndex criAtomExPlayback_GetCurrentBlockIndex | ( | CriAtomExPlaybackId | id | ) |
Get the current block index of the sound beng played back.
[in] | id | playback ID |
CriBool criAtomExPlayback_GetPlaybackTrackInfo | ( | CriAtomExPlaybackId | id, |
CriAtomExPlaybackTrackInfo * | info | ||
) |
Get the playback track info.
[in] | id | playback ID |
[out] | info | playback track info |
CriBool criAtomExPlayback_GetBeatSyncInfo | ( | CriAtomExPlaybackId | id, |
CriAtomExBeatSyncInfo * | info | ||
) |
Get the beat synchronization information.
[in] | id | playback ID |
[out] | info | beat synchronization info |
CriBool criAtomExPlayback_SetBeatSyncOffset | ( | CriAtomExPlaybackId | id, |
CriSint16 | time_ms | ||
) |
Beat sync offset setting.
[in] | id | playback ID |
[in] | time_ms | Offset time |