Detailed Description

Exports for User.

Using this library in your project

Include the header file in your project:

#include <psp2/avplayer.h>

avplayer.h

Link the library to the executable:

SceAvPlayer_stub

Load the required module:

sceSysmoduleLoadModule(SCE_SYSMODULE_AVPLAYER);

sceSysmoduleLoadModule

int sceSysmoduleLoadModule(SceSysmoduleModuleId id)

Load a module.

SCE_SYSMODULE_AVPLAYER

@ SCE_SYSMODULE_AVPLAYER

AVPlayer module.

Definition: sysmodule.h:103

Functions
	VITASDK_BUILD_ASSERT_EQ (4, SceAvPlayerHandle)

	VITASDK_BUILD_ASSERT_EQ (0x14, SceAvPlayerMemReplacement)

	VITASDK_BUILD_ASSERT_EQ (0x14, SceAvPlayerFileReplacement)

	VITASDK_BUILD_ASSERT_EQ (8, SceAvPlayerEventReplacement)

	VITASDK_BUILD_ASSERT_EQ (0x48, SceAvPlayerInitData)

	VITASDK_BUILD_ASSERT_EQ (0x10, SceAvPlayerAudio)

	VITASDK_BUILD_ASSERT_EQ (0x10, SceAvPlayerVideo)

	VITASDK_BUILD_ASSERT_EQ (8, SceAvPlayerTextPosition)

	VITASDK_BUILD_ASSERT_EQ (0x10, SceAvPlayerTimedText)

	VITASDK_BUILD_ASSERT_EQ (0x10, SceAvPlayerStreamDetails)

	VITASDK_BUILD_ASSERT_EQ (0x20, SceAvPlayerFrameInfo)

	VITASDK_BUILD_ASSERT_EQ (0x28, SceAvPlayerStreamInfo)

SceAvPlayerHandle	sceAvPlayerInit (SceAvPlayerInitData *data)

int	sceAvPlayerPause (SceAvPlayerHandle handle)

int	sceAvPlayerResume (SceAvPlayerHandle handle)

int	sceAvPlayerStart (SceAvPlayerHandle handle)

int	sceAvPlayerStop (SceAvPlayerHandle handle)

int	sceAvPlayerSetLooping (SceAvPlayerHandle handle, SceBool looping)

SceBool	sceAvPlayerIsActive (SceAvPlayerHandle handle)

int	sceAvPlayerAddSource (SceAvPlayerHandle handle, const char *filename)

int	sceAvPlayerClose (SceAvPlayerHandle handle)

SceBool	sceAvPlayerGetAudioData (SceAvPlayerHandle handle, SceAvPlayerFrameInfo *info)

SceBool	sceAvPlayerGetVideoData (SceAvPlayerHandle handle, SceAvPlayerFrameInfo *info)

uint64_t	sceAvPlayerCurrentTime (SceAvPlayerHandle handle)

int	sceAvPlayerJumpToTime (SceAvPlayerHandle handle, uint64_t offset)

int	sceAvPlayerSetTrickSpeed (SceAvPlayerHandle handle, int speed)

int	sceAvPlayerGetStreamInfo (SceAvPlayerHandle handle, uint32_t id, SceAvPlayerStreamInfo *info)

Typedefs
typedef int	SceAvPlayerHandle

typedef void (	SceAvPlayerAlloc) (void *arg, uint32_t alignment, uint32_t size)

typedef void(*	SceAvPlayerFree) (void arg, void ptr)

typedef void (	SceAvPlayerAllocFrame) (void *arg, uint32_t alignment, uint32_t size)

typedef void(*	SceAvPlayerFreeFrame) (void arg, void ptr)

typedef int(*	SceAvPlayerOpenFile) (void p, const char filename)

typedef int(*	SceAvPlayerCloseFile) (void *p)

typedef int(*	SceAvPlayerReadOffsetFile) (void p, uint8_t buffer, uint64_t position, uint32_t length)

typedef uint64_t(*	SceAvPlayerSizeFile) (void *p)

typedef void(*	SceAvPlayerEventCallback) (void p, int32_t argEventId, int32_t argSourceId, void argEventData)

Data Structure Documentation

◆ SceAvPlayerMemReplacement

struct SceAvPlayerMemReplacement

Data Fields
void *	objectPointer
SceAvPlayerAlloc	allocate	Memory allocator for generic data.
SceAvPlayerFree	deallocate	Memory deallocator for generic data.
SceAvPlayerAllocFrame	allocateTexture	Memory allocator for video frames.
SceAvPlayerFreeFrame	deallocateTexture	Memory deallocator for video frames.

◆ SceAvPlayerFileReplacement

struct SceAvPlayerFileReplacement

Data Fields
void *	objectPointer
SceAvPlayerOpenFile	open	File open.
SceAvPlayerCloseFile	close	File close.
SceAvPlayerReadOffsetFile	readOffset	File read from offset.
SceAvPlayerSizeFile	size	File size.

◆ SceAvPlayerEventReplacement

struct SceAvPlayerEventReplacement

Data Fields
void *	objectPointer
SceAvPlayerEventCallback	eventCallback

◆ SceAvPlayerInitData

struct SceAvPlayerInitData

Data Fields
SceAvPlayerMemReplacement	memoryReplacement	Memory allocator replacement.
SceAvPlayerFileReplacement	fileReplacement	File I/O replacement.
SceAvPlayerEventReplacement	eventReplacement	Event callback replacement.
int32_t	debugLevel
uint32_t	basePriority	Base priority of the thread running the video player.
int32_t	numOutputVideoFrameBuffers
SceBool	autoStart	Flag indicating whether the video player should start playback automatically.
uint8_t	reserved[3]	Reserved data.
const char *	defaultLanguage

◆ SceAvPlayerAudio

struct SceAvPlayerAudio

Data Fields
uint16_t	channelCount	The number of audio channels of the audio frame.
uint8_t	reserved[2]	Reserved data.
uint32_t	sampleRate	The samplerate of the audio frame in Hz.
uint32_t	size	The size of the audio frame in bytes.
uint32_t	languageCode	The language code of the audio frame.

◆ SceAvPlayerVideo

struct SceAvPlayerVideo

Data Fields
uint32_t	width	The width of the video frame in pixels.
uint32_t	height	The height of the video frame in pixels.
float	aspectRatio	The aspect ratio of the video frame.
uint32_t	languageCode	The language code of the video frame.

◆ SceAvPlayerTextPosition

struct SceAvPlayerTextPosition

Data Fields
uint16_t	top
uint16_t	left
uint16_t	bottom
uint16_t	right

◆ SceAvPlayerTimedText

struct SceAvPlayerTimedText

Data Fields
uint32_t	languageCode	The language code of the subtitles.
uint16_t	textSize	The size of the subtitles.
uint16_t	fontSize	The size of the subtitles.
SceAvPlayerTextPosition	position	The position of the subtitles.

◆ SceAvPlayerStreamDetails

union SceAvPlayerStreamDetails

Data Fields
uint32_t	reserved[4]	Reserved data.
SceAvPlayerAudio	audio	Audio details.
SceAvPlayerVideo	video	Video details.
SceAvPlayerTimedText	subs	Subtitles details.

◆ SceAvPlayerFrameInfo

struct SceAvPlayerFrameInfo

Data Fields
uint8_t *	pData	Pointer to the frame data.
uint32_t	reserved	Reserved data.
uint64_t	timeStamp	Timestamp of the frame in milliseconds.
SceAvPlayerStreamDetails	details	The frame details.

◆ SceAvPlayerStreamInfo

struct SceAvPlayerStreamInfo

Data Fields
uint32_t	type	Type of the stream (One of SceAvPlayerStreamType)
uint32_t	reserved	Reserved data
SceAvPlayerStreamDetails	details	The stream details.
uint64_t	duration	Total duration of the stream in milliseconds.
uint64_t	startTime	Starting time of the stream in milliseconds.

Typedef Documentation

◆ SceAvPlayerHandle

typedef int SceAvPlayerHandle

◆ SceAvPlayerAlloc

typedef void*(* SceAvPlayerAlloc) (void *arg, uint32_t alignment, uint32_t size)

◆ SceAvPlayerFree

typedef void(* SceAvPlayerFree) (void *arg, void *ptr)

◆ SceAvPlayerAllocFrame

typedef void*(* SceAvPlayerAllocFrame) (void *arg, uint32_t alignment, uint32_t size)

◆ SceAvPlayerFreeFrame

typedef void(* SceAvPlayerFreeFrame) (void *arg, void *ptr)

◆ SceAvPlayerOpenFile

typedef int(* SceAvPlayerOpenFile) (void *p, const char *filename)

◆ SceAvPlayerCloseFile

typedef int(* SceAvPlayerCloseFile) (void *p)

◆ SceAvPlayerReadOffsetFile

typedef int(* SceAvPlayerReadOffsetFile) (void *p, uint8_t *buffer, uint64_t position, uint32_t length)

◆ SceAvPlayerSizeFile

typedef uint64_t(* SceAvPlayerSizeFile) (void *p)

◆ SceAvPlayerEventCallback

typedef void(* SceAvPlayerEventCallback) (void *p, int32_t argEventId, int32_t argSourceId, void *argEventData)

Enumeration Type Documentation

◆ SceAvPlayerErrorCode

enum SceAvPlayerErrorCode

Enumerator
SCE_AVPLAYER_ERROR_INVALID_PARAM
SCE_AVPLAYER_ERROR_OUT_OF_MEMORY

◆ SceAvPlayerTrickSpeeds

enum SceAvPlayerTrickSpeeds

Enumerator
SCE_AVPLAYER_TRICK_SPEED_REWIND_32X	Rewind 32x.
SCE_AVPLAYER_TRICK_SPEED_REWIND_16X	Rewind 16x.
SCE_AVPLAYER_TRICK_SPEED_REWIND_8X	Rewind 8x.
SCE_AVPLAYER_TRICK_SPEED_NORMAL	Normal Speed.
SCE_AVPLAYER_TRICK_SPEED_FAST_FORWARD_2X	Fast Forward 2x.
SCE_AVPLAYER_TRICK_SPEED_FAST_FORWARD_4X	Fast Forward 4x.
SCE_AVPLAYER_TRICK_SPEED_FAST_FORWARD_8X	Fast Forward 8x.
SCE_AVPLAYER_TRICK_SPEED_FAST_FORWARD_16X	Fast Forward 16x.
SCE_AVPLAYER_TRICK_SPEED_FAST_FORWARD_32X	Fast Forward 32x.

◆ SceAvPlayerStreamType

enum SceAvPlayerStreamType

Enumerator
SCE_AVPLAYER_VIDEO	Video stream type.
SCE_AVPLAYER_AUDIO	Audio stream type.
SCE_AVPLAYER_TIMEDTEXT	Timed text (subtitles) stream type.

Function Documentation

◆ VITASDK_BUILD_ASSERT_EQ() [1/12]

VITASDK_BUILD_ASSERT_EQ	(	4	,
		SceAvPlayerHandle
	)

◆ VITASDK_BUILD_ASSERT_EQ() [2/12]

VITASDK_BUILD_ASSERT_EQ	(	0x14	,
		SceAvPlayerMemReplacement
	)

◆ VITASDK_BUILD_ASSERT_EQ() [3/12]

VITASDK_BUILD_ASSERT_EQ	(	0x14	,
		SceAvPlayerFileReplacement
	)

◆ VITASDK_BUILD_ASSERT_EQ() [4/12]

VITASDK_BUILD_ASSERT_EQ	(	8	,
		SceAvPlayerEventReplacement
	)

◆ VITASDK_BUILD_ASSERT_EQ() [5/12]

VITASDK_BUILD_ASSERT_EQ	(	0x48	,
		SceAvPlayerInitData
	)

◆ VITASDK_BUILD_ASSERT_EQ() [6/12]

VITASDK_BUILD_ASSERT_EQ	(	0x10	,
		SceAvPlayerAudio
	)

◆ VITASDK_BUILD_ASSERT_EQ() [7/12]

VITASDK_BUILD_ASSERT_EQ	(	0x10	,
		SceAvPlayerVideo
	)

◆ VITASDK_BUILD_ASSERT_EQ() [8/12]

VITASDK_BUILD_ASSERT_EQ	(	8	,
		SceAvPlayerTextPosition
	)

◆ VITASDK_BUILD_ASSERT_EQ() [9/12]

VITASDK_BUILD_ASSERT_EQ	(	0x10	,
		SceAvPlayerTimedText
	)

◆ VITASDK_BUILD_ASSERT_EQ() [10/12]

VITASDK_BUILD_ASSERT_EQ	(	0x10	,
		SceAvPlayerStreamDetails
	)

◆ VITASDK_BUILD_ASSERT_EQ() [11/12]

VITASDK_BUILD_ASSERT_EQ	(	0x20	,
		SceAvPlayerFrameInfo
	)

◆ VITASDK_BUILD_ASSERT_EQ() [12/12]

VITASDK_BUILD_ASSERT_EQ	(	0x28	,
		SceAvPlayerStreamInfo
	)

◆ sceAvPlayerInit()

SceAvPlayerHandle sceAvPlayerInit ( SceAvPlayerInitData * data )

Parameters

[in] data - Init data for the video player

Returns: The video player handle on success, < 0 on error.

◆ sceAvPlayerPause()

int sceAvPlayerPause ( SceAvPlayerHandle handle )

Parameters

[in] handle - A player handle created with sceAvPlayerInit

Returns: 0 on success, < 0 on error.

◆ sceAvPlayerResume()

int sceAvPlayerResume ( SceAvPlayerHandle handle )

Parameters

[in] handle - A player handle created with sceAvPlayerInit

Returns: 0 on success, < 0 on error.

◆ sceAvPlayerStart()

int sceAvPlayerStart ( SceAvPlayerHandle handle )

Parameters

[in] handle - A player handle created with sceAvPlayerInit

Returns: 0 on success, < 0 on error.

◆ sceAvPlayerStop()

int sceAvPlayerStop ( SceAvPlayerHandle handle )

Parameters

[in] handle - A player handle created with sceAvPlayerInit

Returns: 0 on success, < 0 on error.

◆ sceAvPlayerSetLooping()

int sceAvPlayerSetLooping	(	SceAvPlayerHandle	handle,
		SceBool	looping
	)

Parameters

[in]	handle	- A player handle created with sceAvPlayerInit
[in]	looping	- A flag indicating whether the video playback should loop

Returns: 0 on success, < 0 on error.

◆ sceAvPlayerIsActive()

SceBool sceAvPlayerIsActive ( SceAvPlayerHandle handle )

Parameters

[in] handle - A player handle created with sceAvPlayerInit

Returns: SCE_TRUE if the video playback is active, SCE_FALSE otherwise.

◆ sceAvPlayerAddSource()

int sceAvPlayerAddSource	(	SceAvPlayerHandle	handle,
		const char *	filename
	)

Parameters

[in]	handle	- A player handle created with sceAvPlayerInit
[in]	filename	- Full path to the file to play

Returns: 0 on success, < 0 on error.

◆ sceAvPlayerClose()

int sceAvPlayerClose ( SceAvPlayerHandle handle )

Parameters

[in] handle - A player handle created with sceAvPlayerInit

Returns: 0 on success, < 0 on error.

◆ sceAvPlayerGetAudioData()

SceBool sceAvPlayerGetAudioData	(	SceAvPlayerHandle	handle,
		SceAvPlayerFrameInfo *	info
	)

Parameters

[in]	handle	- A player handle created with sceAvPlayerInit
[out]	info	- Descriptor for the received data

Returns: SCE_TRUE if new data is available, SCE_FALSE otherwise.

◆ sceAvPlayerGetVideoData()

SceBool sceAvPlayerGetVideoData	(	SceAvPlayerHandle	handle,
		SceAvPlayerFrameInfo *	info
	)

Parameters

[in]	handle	- A player handle created with sceAvPlayerInit
[out]	info	- Descriptor for the received data

Returns: SCE_TRUE if new data is available, SCE_FALSE otherwise.

◆ sceAvPlayerCurrentTime()

uint64_t sceAvPlayerCurrentTime ( SceAvPlayerHandle handle )

Parameters

[in] handle - A player handle created with sceAvPlayerInit

Returns: Current time on the video playback in milliseconds.

◆ sceAvPlayerJumpToTime()

int sceAvPlayerJumpToTime	(	SceAvPlayerHandle	handle,
		uint64_t	offset
	)

Parameters

[in]	handle	- A player handle created with sceAvPlayerInit
[in]	offset	- Offset to jump to on the video playback in milliseconds.

Returns: 0 on success, < 0 on error.

◆ sceAvPlayerSetTrickSpeed()

int sceAvPlayerSetTrickSpeed	(	SceAvPlayerHandle	handle,
		int	speed
	)

Parameters

[in]	handle	- A player handle created with sceAvPlayerInit
[in]	offset	- One of SceAvPlayerTrickSpeeds.

Returns: 0 on success, < 0 on error.

◆ sceAvPlayerGetStreamInfo()

int sceAvPlayerGetStreamInfo	(	SceAvPlayerHandle	handle,
		uint32_t	id,
		SceAvPlayerStreamInfo *	info
	)

Parameters

[in]	handle	- A player handle created with sceAvPlayerInit
[in]	id	- Stream ID to get info for.
[out]	info	- Info retrieved for the requested stream.

Returns: 0 on success, < 0 on error.

Detailed Description

Using this library in your project

Functions

Typedefs

Data Structure Documentation

◆ SceAvPlayerMemReplacement

◆ SceAvPlayerFileReplacement

◆ SceAvPlayerEventReplacement

◆ SceAvPlayerInitData

◆ SceAvPlayerAudio

◆ SceAvPlayerVideo

◆ SceAvPlayerTextPosition

◆ SceAvPlayerTimedText

◆ SceAvPlayerStreamDetails

◆ SceAvPlayerFrameInfo

◆ SceAvPlayerStreamInfo

Typedef Documentation

◆ SceAvPlayerHandle

◆ SceAvPlayerAlloc

◆ SceAvPlayerFree

◆ SceAvPlayerAllocFrame

◆ SceAvPlayerFreeFrame

◆ SceAvPlayerOpenFile

◆ SceAvPlayerCloseFile

◆ SceAvPlayerReadOffsetFile

◆ SceAvPlayerSizeFile

◆ SceAvPlayerEventCallback

Enumeration Type Documentation

◆ SceAvPlayerErrorCode

◆ SceAvPlayerTrickSpeeds

◆ SceAvPlayerStreamType

Function Documentation

◆ VITASDK_BUILD_ASSERT_EQ() [1/12]

◆ VITASDK_BUILD_ASSERT_EQ() [2/12]

◆ VITASDK_BUILD_ASSERT_EQ() [3/12]

◆ VITASDK_BUILD_ASSERT_EQ() [4/12]

◆ VITASDK_BUILD_ASSERT_EQ() [5/12]

◆ VITASDK_BUILD_ASSERT_EQ() [6/12]

◆ VITASDK_BUILD_ASSERT_EQ() [7/12]

◆ VITASDK_BUILD_ASSERT_EQ() [8/12]

◆ VITASDK_BUILD_ASSERT_EQ() [9/12]

◆ VITASDK_BUILD_ASSERT_EQ() [10/12]

◆ VITASDK_BUILD_ASSERT_EQ() [11/12]

◆ VITASDK_BUILD_ASSERT_EQ() [12/12]

◆ sceAvPlayerInit()

◆ sceAvPlayerPause()

◆ sceAvPlayerResume()

◆ sceAvPlayerStart()

◆ sceAvPlayerStop()

◆ sceAvPlayerSetLooping()

◆ sceAvPlayerIsActive()

◆ sceAvPlayerAddSource()

◆ sceAvPlayerClose()

◆ sceAvPlayerGetAudioData()

◆ sceAvPlayerGetVideoData()

◆ sceAvPlayerCurrentTime()

◆ sceAvPlayerJumpToTime()

◆ sceAvPlayerSetTrickSpeed()

◆ sceAvPlayerGetStreamInfo()