CRI ADX  Last Updated: 2024-07-17 10:47 p
CriAtomHcaMxPlayerConfigTag Struct Reference

#include <cri_le_atom.h>

Data Fields

CriSint32 max_channels
 Maximum number of output channels. More...
 
CriSint32 max_sampling_rate
 Maximum sampling rate. More...
 
CriBool streaming_flag
 Whether to perform streaming playback. More...
 

Detailed Description

HCA-MX player creation configuration structure

Description:
Structure for specifying the behavior when creating a player capable of HCA-MX playback.
This structure is specified as an argument of the criAtomPlayer_CreateHcaMxPlayer function.

When a handle to the player is created, as much internal resources as needed are allocated for the player based on the settings specified in the structure.
The size of the work area needed for the player varies depending on the parameters specified in the structure.
Attention
More members will be added in the future. So, when not using the criAtomPlayer_SetDefaultConfigForHcaMxPlayer macro, make sure to initialize the structure to zero before using it.
(Make sure that no indefinite value is set to any member of the structure.)
See also
criAtomPlayer_CreateHcaMxPlayer, criAtomPlayer_SetDefaultConfigForHcaMxPlayer

Field Documentation

◆ max_channels

CriSint32 max_channels

Maximum number of output channels.

Description:
Specifies the number of channels for the sounds played by an Atom player.
Atom player created with the criAtomPlayer_CreateHcaMxPlayer function can play back audio data with number of output channels less than or equal to the number of channels specified with max_channels.

◆ max_sampling_rate

CriSint32 max_sampling_rate

Maximum sampling rate.

Description:
Specifies the sampling rate of the sounds played by an Atom player.
Atom player created with the criAtomPlayer_CreateHcaMxPlayer function can play back audio data with sampling rate equal to the value specified with max_sampling_rate.

Remarks:
The size of work memory necessary to create the Atom player can be reduced by reducing the maximum sampling rate.
Attention
You cannot play back data exceeding the specified maximum sampling rate.
For example, if the maximum sampling rate is set to 48000, 48000Hz audio cannot be played with the created Atom player.
(It is not rate converted and output.)

◆ streaming_flag

CriBool streaming_flag

Whether to perform streaming playback.

Description:
Specifies whether to perform streaming playback (playback from file) with Atom player.
If streaming_flag is set to CRI_FALSE, the created Atom player will support only on-memory data playback (playback of memory address specified with the criAtomPlayer_SetData function). (Playback from file is not possible.)
If streaming_flag is set to CRI_TRUE, the created Atom player will support on-memory data playback and playback from file (playback of file specified with the criAtomPlayer_SetFile function or criAtomPlayer_SetContentId function.
Supplement:
If streaming_flag is set to CRI_TRUE, resource for reading file is allocated when creating Atom player.
Therefore, compared to when the streaming_flag is set to CRI_FALSE, more memory is required to create the Atom player.

The documentation for this struct was generated from the following file: