CRI Sofdec2  Last Updated: 2022-11-21 16:25 p
CriManaPlayerConfig Struct Reference

Configuration structure for player creation. More...

#include <cri_mana.h>

Data Fields

CriUint32 readbuf_size_byte
 Input buffer size (unit: byte) More...
 
CriBool use_atomex_player
 Flag to use ::criAtomExPlayer for sound playback. More...
 
CriSint32 max_path
 Maximum path length (in bytes) More...
 

Detailed Description

Configuration structure for player creation.

Description:
This is a data type for specifying operation specifications when the Mana player is used for movie playback.
Specifies the criManaPlayer_CreateWithConfig function argument.

The player that was created will allocate only as many internal resources as are necessary according to the settings specified by the structure during handle creation.

When the config structure is not used in handle creation, internal resources are allocated as playback work after playback begins. Only use this structure when the specs of the movie to be played back have been determined beforehand.
See also
criManaPlayer_CreateWithConfig

Field Documentation

◆ readbuf_size_byte

CriUint32 readbuf_size_byte

Input buffer size (unit: byte)

Description:
You can specify the size of the input buffer allocated internally by the Mana player for playback.

Specifying anything but zero will create an input buffer with a size specified during handle creation.
If you specify zero, an input buffer will not be created during handle creation but rather allocated when playback work is allocated.
Calculation method:
  • Input buffer size = Max bit rate (bps) of the movie to be played back / 8 * buffering time (secs)
    Ex.) When playing a movie with a max 2Mbps: 2*1000*1000 / 8 * 1.0f = 250000
Caution:
Making the input buffer size too small may delay playback. Allocate more than one second, even if the buffering time is small.
We recommend making the size a little larger to match this number during multi-streaming playback.

◆ use_atomex_player

CriBool use_atomex_player

Flag to use ::criAtomExPlayer for sound playback.

Description:
By specifying CRI_TRUE for this flag, ::criAtomExPlayer is used for player's sound playback. It is possible to obtain this criAtomExPlayer handle with ::criManaPlayer_GetAtomExPlayer function.

◆ max_path

CriSint32 max_path

Maximum path length (in bytes)

Description:
The maximum file path length that can be specified for the Mana player.
When handling a file path length that exceeds CRIMANA_MAX_FILE_NAME, you can extend the upper limit of the path length that can be used by Mana player by specifying max_path as long as expected.
Remarks:
If CRIMANA_MAX_FILE_NAME or less is specified, max_path will be set to CRIMANA_MAX_FILE_NAME.
Attention
  • When extending the maximum path length for Mana players, The CRI File System library must also initialize the CRI File System library in advance by specifying the maximum length in max_path of the CriFsConfig member.
  • The maximum path length must be specified including the terminating null character. (It is necessary to specify the value of "number of characters + 1 byte".)

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