Rockchip RKADK Application Development Guide

Based on the Chinese and English Rockchip RKADK V2.3.2 sources, retaining the 14 technical chapters, APIs, type definitions and examples. This ArmSoM platform reference requires checking the specific board, SoC, SDK/BSP, kernel and peripherals; it does not establish support for every ArmSoM board. Examples come from the source documents. No commands or hardware tests were executed.

Chapter 3 numbering differs: Chinese has 3.1 Overview, 3.2 API Reference and 3.3 Data Types; English places the overview directly under the chapter and numbers API/types 3.1/3.2. Each language retains its source numbering. Chinese 3.3.6 is titled RKADK_MUXER_MANUAL_SPLIT_ATTR_S; English 3.2.6 says RKADK_REC_MANUAL_SPLIT_ATTR_S. Check the actual SDK headers before choosing a type. The English declaration of RKADK_RECORD_Single_Stop joins RKADK_STREAM_TYPE_EenStrmType; the source spelling is retained, and the type/argument separation must be verified against the SDK.

Both source releases are dated 2025-08-04. The manual-split structure typedef ends with MUXER_MANUAL_SPLIT_ATTR_S; the following manual-split enumeration ends with RKADK_MUXER_MANUAL_SPLIT_ATTR_S, despite its type-enumeration heading. These source definitions are retained and must not be treated as verified compilable SDK headers. RKADK_MUXER_Disbale, librokadk.so, RGBA9888 and RV1103/RV1103 in the player platform list are also source spellings; verify them against the SDK. Spaces have been restored at wrapped declaration lines without changing parameters, pointers or identifiers.

1. System Overview

Rkadk provides basic and universal components such as video recording, photo capture, playback, preview, etc., simplifying the difficulty of application development and supporting the rapid development of audio and video recording-related software. This component only supports the implementation of single-process functionality. It does not support multiple processes used simultaneously unless noted otherwise.

1.1 Version Introduction

Version 1.x.x: Further encapsulation based on rkmedia and rockit, corresponding to the master repository. Version 2.x.x: Further encapsulation based on rockit, corresponding to the develop repository.

2. Record

2.1 Overview

Provides basic video recording functionality, offering the following features to product: Creation and destruction of recording tasks Start and stop of recording tasks Manual slice of recording files Time-lapse recording Pre-recording Picture-In-Picture (PiP) recording Recording tasks obtain video and audio information through the parameter module, start and stop VENC (video encoding), start and stop AENC (audio encoding), and call the muxer module to create recording files and write frames to the files. Each recording task corresponds to one or more recording files. Each file must correspond to a video encoding channel, and if audio recording is needed, an audio encoding channel must be added. Multiple recording files under the same recording task have the same recording type, the same slicing conditions, and in time-lapse recording mode, they also have the same time-lapse interval. Different recording times can be configured.

Post AI ISP: RV1106/RV1126/RV1109 chip supports noise reduction in dim light environments and intelligent enhancement processing of VI output images through AI ISP, which can still present a clearer picture without dragging shadows, low noise, and even in dim light environments.

2.2 API Reference

2.2.1 RKADK_RECORD_Create

Description

Create a video recording task.

Syntax

RKADK_S32 RKADK_RECORD_Create(RKADK_RECORD_ATTR_S *pstRecAttr, RKADK_MW_PTR *ppRecorder);

Parameters

Return value

Requirement

Header file: rkadk_record.h Library file: librkadk.so

Notice

Each recording task supports a maximum of 2 recording files simultaneously. Each recording file must have at least 1 video stream and supports encapsulating 1 video stream and 1 audio stream simultaneously at most. It does not support the creation of the same task repeatedly. After creating a recording task, RKADK_RECORD_Start must be called to start recording. To enable the Picture-in-Picture feature, it must be enabled through stPipAttr when RKADK_RECORD_Create, which will then create the Picture-in-Picture pathway.

Example

rkadk_record_test.

See Also

RKADK_RECORD_Destroy.

2.2.2 RKADK_RECORD_Destroy

Description

Destroy video tasks.

Syntax

RKADK_S32 RKADK_RECORD_Destroy(RKADK_MW_PTR pRecorder);

Parameters

Return value

Requirement

Header file: rkadk_record.h Library file: librkadk.so

Notice

The RKADK_RECORD_Destroy interface can only be used after creating a recording task. Only created recording tasks can be destroyed, and repeated destruction of the same recording task is not supported.

Example

rkadk_record_test.

See Also

RKADK_RECORD_Create

2.2.3 RKADK_RECORD_Start

Description

Start recording task.

Syntax

RKADK_S32 RKADK_RECORD_Start(RKADK_MW_PTR pRecorder);

Parameters

Return value

Requirement

Header file: rkadk_record.h Library file: librkadk.so

Notice

The RKADK_RECORD_Start interface can only be used after creating a recording task. It is possible to restart a recording task after stopping it.

Example

rkadk_record_test.

See Also

RKADK_RECORD_Stop

2.2.4 RKADK_RECORD_Stop

Description

Stop recording task.

Syntax

RKADK_S32 RKADK_RECORD_Stop(RKADK_MW_PTR pRecorder);

Parameters

Return value

Requirement

Header file: rkadk_record.h Library file: librkadk.so

Notice

The RKADK_RECORD_Stop interface can only be used after creating a recording task. Repeatedly stopping the same recording task is not supported.

Example

rkadk_record_test.

See Also

RKADK_RECORD_Start

2.2.5 RKADK_RECORD_Single_Start

Description

Start the recording task for a specified stream.

Syntax

RKADK_S32 RKADK_RECORD_Single_Start(RKADK_MW_PTR pRecorder, RKADK_STREAM_TYPE_E enStrmType);

Parameters

Return Value

Requirements

Header file: rkadk_record.h Library file: librkadk.so

Notes

The RKADK_RECORD_Single_Start interface can only be used after creating a recording task. Used in conjunction with RKADK_RECORD_Single_Stop. Supports restarting the recording task after stopping.

Example

rkadk_record_test.

Related Topics

RKADK_RECORD_Single_Stop.

2.2.6 RKADK_RECORD_Single_Stop

Description

Stop the recording task for a specified stream.

Syntax

RKADK_S32 RKADK_RECORD_Single_Stop(RKADK_MW_PTR pRecorder, RKADK_STREAM_TYPE_EenStrmType);

Parameters

Return Values

Requirements

Header file: rkadk_record.h Library file: librkadk.so

Notes

The RKADK_RECORD_Stop interface can only be used after creating a recording task. Use in conjunction with RKADK_RECORD_Single_Start. Does not support stopping the same recording task repeatedly.

Example

rkadk_record_test.

Related Topics

RKADK_RECORD_Single_Start

2.2.7 RKADK_RECORD_Reset

Description

Reconfigure the recording task.

Syntax

RKADK_S32 RKADK_RECORD_Reset(RKADK_MW_PTR *ppRecorder);

parameters

Return value

Requirement

Header file: rkadk_record.h Library file: librkadk.so

Notice

The RKADK_RECORD_Reset interface can only be used after creating a recording task. When switching resolution, frame rate, bit rate, encoding type, or recording type, reset the parameters of the Record module in the ini file by using the RKADK_PARAM_SetCamParam API. RV1126/RV1109 and RK3576 does not support dynamic switching of resolution and encoding type. You

need to RKADK_RECORD_Destroy first, then configure the new resolution or encoding type, and finally RKADK_RECORD_Create again. If Record and other modules share the VI channel, both the resolution of Record and multiplexing modules need to be switched simultaneously to avoid VI and VENC resolution mismatch.

Example

rkadk_record_test.

See Also

None

2.2.8 RKADK_RECORD_ManualSplit

Description

Manually split video files.

Syntax

RKADK_S32 RKADK_RECORD_ManualSplit(RKADK_MW_PTR pRecorder, RKADK_REC_MANUAL_SPLIT_ATTR_S *pstSplitAttr);

Parameters

Return value

Requirement

Header file: rkadk_record.h Library file: librkadk.so

Notice

The RKADK_RECORD_ManualSplit interface can only be used after creating a recording task. Supports repeated manual splitting of video files when the manual splitting of video files has not ended.

Example

rkadk_record_test.

See Also

No

2.2.9 RKADK_RECORD_GetAencChn

Description

Get the video AENC channel ID.

Syntax

RKADK_S32 RKADK_RECORD_GetAencChn();

Return value

AENC channel ID used for recording.

Requirement

Header file: rkadk_record.h Library file: librkadk.so

2.2.10 RKADK_GetThmInMp4

Description

Get thumbnail data from MP4 files.

Syntax

RKADK_S32 RKADK_GetThmInMp4(RKADK_U32 u32CamId, RKADK_CHAR *pszFileName, RKADK_U8 *pu8Buf, RKADK_U32 *pu32Size);

Parameters

Return value

Requirement

Header file: rkadk_thumb.h Library file: librkadk.so

Example

rkadk_thumb_test

See Also

None

2.2.11 RKADK_GetThmInMp4Ex

Description

MP4 obtains thumbnail extension interface, obtains thumbnail data from MP4 files, and supports specifying the type and resolution of output thumbnails. It must be used together with RKADK_ThmBufFree.

Syntax

RKADK_S32 RKADK_GetThmInMp4Ex(RKADK_U32 u32CamId, RKADK_CHAR *pszFileName, RKADK_THUMB_ATTR_S *pstThumbAttr);

Parameters

Return value

Requirement

Header file: rkadk_thumb.h Library file: librkadk.so

Example

rkadk_thumb_test

See Also

RKADK_ThmBufFree

2.2.12 RKADK_ThmBufFree

Description

Release the memory requested by RKADK_GetThmInMp4Ex. It must be used together with RKADK_GetThmInMp4Ex.

Syntax

RKADK_S32 RKADK_ThmBufFree(RKADK_THUMB_ATTR_S *pstThumbAttr);

Parameters

Return value

Requirement

Header file: rkadk_thumb.h Library file: librkadk.so

Example

rkadk_thumb_test

See Also

RKADK_GetThmInMp4Ex

2.2.13 RKADK_RECORD_SetRotation

Description

Set Record rotation.

Syntax

RKADK_S32 RKADK_RECORD_SetRotation(RKADK_MW_PTR pRecorder, ROTATION_E enRotation, RKADK_STREAM_TYPE_E enStreamType);

Parameters

Return value

Requirement

Header file: rkadk_record.h Library file: librkadk.so

Example

rkadk_record_test

2.2.14 RKADK_RECORD_ToggleMirror

Description

Set Record Mirror.

Syntax

RKADK_S32 RKADK_RECORD_ToggleMirror(RKADK_MW_PTR pRecorder, RKADK_STREAM_TYPE_E enStrmType, bool mirror);

Parameters

Return value

Requirement

Header file: rkadk_record.h Library file: librkadk.so

2.2.15 RKADK_RECORD_ToggleFlip

Description

Set Record Flip.

Syntax

RKADK_S32 RKADK_RECORD_ToggleFlip(RKADK_MW_PTR pRecorder, RKADK_STREAM_TYPE_E enStrmType, bool flip);

Parameters

Return value

Requirement

Header file: rkadk_record.h Library file: librkadk.so

2.2.16 RKADK_RECORD_FileCacheInit

Description

File Cache initialization is aimed at making file writing smoother. Enabling File Cache means that files are written to the storage device through DirectIO, and the kernel’s cache mechanism is not effective.

Syntax

RKADK_S32 RKADK_RECORD_FileCacheInit(FILE_CACHE_ARG *pstFileCacheAttr)

Parameters

Return value

Requirement

Header file: rkadk_record.h Library file: librkadk.so

Notice

File Cache is not enabled by default. To enable File Cache, the file_cache_env environment variable must be set

export file_cache_env=1

If File Cache is enabled, this interface must be called before RKADK_RECORD_Create, and only needs to be called once, otherwise there is no need to call it. Enabling File Cache will need additional memory, and the memory size is determined by u32TotalCache. This interface must be used in pair with RKADK_RECORD_FileCacheDeInit

Example

rkadk_record_test

2.2.17 RKADK_RECORD_FileCacheDeInit

Description

De-initialization File Cache

Syntax

RKADK_S32 RKADK_RECORD_FileCacheDeInit();

Return value

Requirement

Header file: rkadk_record.h Library file: librkadk.so

Notice

It must be used together with RKADK_RECORD_FileCacheInit. If File Cache is enabled, this interface needs to be called after RKADK_RECORD_Destroy, otherwise there is no need to call it. rkadk_record_test

2.2.18 RKADK_RECORD_FileCacheSetMode

Description

Set the recording type for File Cache.

Syntax

void RKADK_RECORD_FileCacheSetMode(RKADK_REC_TYPE_E enRecType);

Parameters

Requirements

Header file: rkadk_record.h Library file: librkadk.so

Notes

After enabling File Cache, when switching recording types, this API must be called to set a new recording type for File Cache. rkadk_aov_record_test

2.2.19 RKADK_MEDIA_EnablePostIsp

Description

Enable post AI ISP, in addition to the interface, you can also enable post AI ISP by configuring post_aiisp in sensor ini.

Syntax

RKADK_S32 RKADK_MEDIA_EnablePostIsp(RKADK_U32 u32CamId, RKADK_STREAM_TYPE_E enStrmType, RKADK_POST_ISP_ATTR_S *pstPostIspAttr);

Parameters

Return value

Requirement

Header file: rkadk_media_comm.h Library file: librkadk.so

2.2.20 RKADK_MEDIA_SetPostIspAttr

Description

Dynamically set post AI ISP attributes.

Syntax

RKADK_S32 RKADK_MEDIA_SetPostIspAttr(RKADK_U32 u32CamId, RKADK_STREAM_TYPE_E enStrmType, bool bEnable, RKADK_POST_ISP_ATTR_S *pstPostIspAttr);

Parameters

Return value

Requirement

Header file: rkadk_media_comm.h Library file: librkadk.so

2.2.21 RKADK_RECORD_SetPipAttr

Description

Dynamically set picture-in-picture (PiP) attributes.

Syntax

RKADK_S32 RKADK_RECORD_SetPipAttr(RKADK_MW_PTR pRecorder, RKADK_PIP_ATTR_S *pstPipAttr);

Parameters

Return Value

Requirements

Header file: rkadk_record.h

Library file: librkadk.so Note To enable the Picture-in-Picture feature, it must be enabled through stPipAttr when RKADK_RECORD_Create, which will then create the Picture-in-Picture pathway.

2.3 Type of Data

The video recording module mainly provides the following data types: RKADK_MW_PTR: Pointer to recording task RECORD_FILE_NUM_MAX: The maximum number of files recorded simultaneously by a single recording task RKADK_REC_EVENT_CALLBACK_FN: Event callback function pointer RKADK_REC_TYPE_E: Recording type enumeration RKADK_REC_REQUEST_FILE_NAMES_FN: Request video file name function pointer RKADK_REC_PTS_CALLBACK_FN: Video frame timestamp callback function pointer RKADK_RECORD_ATTR_S: Recording task attribute structure RKADK_REC_MANUAL_SPLIT_ATTR_S: Manually split attribute structure FILE_CACHE_ARG: File Cache attribute structure RKADK_POST_ISP_ATTR_S: Post AI ISP attribute structure RKADK_MOUNT_SDCARD_FN: SD card mounting function pointer RKADK_AOV_ATTR_S: AOV attribute structure RKADK_PIP_ATTR_S: Picture-in-Picture attribute structure

2.3.1 Public Data Types

Description

Definition of basic data types.

Definition

typedef unsigned char RKADK_U8;
typedef unsigned short RKADK_U16;
typedef unsigned int RKADK_U32;

typedef signed char RKADK_S8;
typedef short RKADK_S16;
typedef int RKADK_S32;

typedef unsigned long RKADK_UL;
typedef signed long RKADK_SL;
typedef float RKADK_FLOAT;
typedef double RKADK_DOUBLE;

#ifndef _M_IX86
typedef unsigned long long RKADK_U64;
typedef long long RKADK_S64;
#else
typedef unsigned __int64 RKADK_U64;
typedef __int64 RKADK_S64;
#endif

typedef char RKADK_CHAR;
#define RKADK_VOID void

typedef unsigned int RKADK_HANDLE;

typedef RKADK_VOID *RKADK_MW_PTR;

typedef char (*ARRAY_FILE_NAME)[RKADK_MAX_FILE_PATH_LEN];

typedef enum {
  RKADK_FALSE = 0,
  RKADK_TRUE = 1,
} RKADK_BOOL;

#ifndef NULL
#define NULL 0L
#endif

#define RKADK_NULL 0L
#define RKADK_SUCCESS 0
#define RKADK_FAILURE (-1)

2.3.2 RKADK_MW_PTR

Description

Define task pointer

Definition

typedef RKADK_VOID *RKADK_MW_PTR;

2.3.3 RKADK_MAX_SENSOR_CNT

Description

Define the maximum number of sensors supported, which can be adjusted according to the actual situation

Definition

#define RKADK_MAX_SENSOR_CNT 8

2.3.4 RECORD_FILE_NUM_MAX

Description

Define the maximum number of files recorded simultaneously by a single recording task.

Definition

#define RECORD_FILE_NUM_MAX 2

2.3.5 RKADK_REC_EVENT_CALLBACK_FN

Description

Define the video event callback function pointer.

Definition

typedef RKADK_MUXER_EVENT_CALLBACK_FN RKADK_REC_EVENT_CALLBACK_FN;

Related data types and interfaces

RKADK_MUXER_EVENT_CALLBACK_FN

2.3.6 RKADK_REC_TYPE_E

Description

Define the enumeration of recording types.

Definition

typedef RKADK_MUXER_REC_TYPE_E RKADK_REC_TYPE_E;

Related Data Types and Interfaces

RKADK_MUXER_REC_TYPE_E

2.3.7 RKADK_REC_REQUEST_FILE_NAMES_FN

Description

Define the callback function pointer to request the video file name.

Definition

typedef RKADK_S32 (*RKADK_REC_REQUEST_FILE_NAMES_FN)(RKADK_MW_PTR pRecorder, RKADK_U32
u32FileCnt, RKADK_CHAR(*paszFilename)[RKADK_MAX_FILE_PATH_LEN]);

Members

Related data types and interfaces

RKADK_MW_PTR RKADK_RECORD_ATTR_S

2.3.8 RKADK_REC_PTS_CALLBACK_FN

Description

Define the video frame timestamp callback function pointer.

Definition

typedef RKADK_MUXER_PTS_CALLBACK_FN RKADK_REC_PTS_CALLBACK_FN;

Related data types and interfaces

RKADK_MUXER_PTS_CALLBACK_FN RKADK_RECORD_ATTR_S

2.3.9 RKADK_MOUNT_SDCARD_FN

Description

Define the SD card mounting function pointer.

Definition

typedef int (*RKADK_MOUNT_SDCARD_FN)(void);

Related Data Types and Interfaces

RKADK_RECORD_ATTR_S

2.3.10 RKADK_RECORD_ATTR_S

Description

Define the recording task attribute structure.

Definition

typedef struct {
  RKADK_S32 s32CamID;                                  /* Camera ID */
  RKADK_U32 u32FragKeyFrame;
  RKADK_REC_REQUEST_FILE_NAMES_FN pfnRequestFileNames; /* rec callbak */
  RKADK_REC_EVENT_CALLBACK_FN pfnEventCallback;        /* event callbak */
  RKADK_AOV_ATTR_S stAovAttr;
  RKADK_POST_ISP_ATTR_S *pstPostIspAttr;
  RKADK_MOUMNT_SDCARD_FN pfnMountSdcard;
  RKADK_PIP_ATTR_S stPipAttr[RECORD_FILE_NUM_MAX];
  RKADK_U32 u32GetThumbTime[RECORD_FILE_NUM_MAX];      /* get thumbnail delay time(ms) when
enbale file cache, default: 3000(ms) */
  RKADK_THIRD_MUXER_ATTR_S *pstThirdMuxerAttr;         /* third party muxer attr */
} RKADK_RECORD_ATTR_S;

Members

Related data types and interfaces

RKADK_REC_EVENT_CALLBACK_FN RKADK_REC_REQUEST_FILE_NAMES_FN RKADK_MOUMNT_SDCARD_FN RKADK_AOV_ATTR_S RKADK_POST_ISP_ATTR_S RKADK_PIP_ATTR_S RKADK_THIRD_MUXER_ATTR_S RKADK_RECORD_Create

2.3.11 RKADK_REC_MANUAL_SPLIT_ATTR_S

Description

Define manually split attribute structure.

Definition

typedef MUXER_MANUAL_SPLIT_ATTR_S RKADK_REC_MANUAL_SPLIT_ATTR_S;

Related data types and interfaces

MUXER_MANUAL_SPLIT_ATTR_S RKADK_RECORD_ManualSplit

2.3.12 FILE_CACHE_ARG

Description

Define the File Cache attribute structure.

Definition

typedef struct _FILE_CACHE_ARG {
  const char *sdcard_path;
  int write_cache;  /* write cache size(byte), default 1M */
  int total_cache;  /* total cache size(byte), default 10M */
  FILE_WRITE_THREAD_ARG write_thread_arg;
  FILE_SDCARD_ARG sdcard_arg;
} FILE_CACHE_ARG;

Members

Related data types and interfaces

RKADK_RECORD_FileCacheInit FILE_WRITE_THREAD_ARG FILE_SDCARD_ARG

2.3.13 FILE_WRITE_THREAD_ARG

Description

Define the write thread attribute structure.

Definition

typedef enum _FILE_SCHED_POLICY {
  FILE_SCHED_OTHER = 0,
  FILE_SCHED_BATCH,
  FILE_SCHED_IDLE,
  FILE_SCHED_FIFO,      /* sched_priority[1, 99] */
  FILE_SCHED_RR,        /* sched_priority[1, 99] */
} FILE_SCHED_POLICY;

typedef struct _FILE_WRITE_THREAD_ARG {
  FILE_SCHED_POLICY sched_policy;
  int priority; /* SCHED_OTHER/SCHED_IDLE/SCHED_BATCH inoperative */
} FILE_WRITE_THREAD_ARG;

Members

Related data types and interfaces

RKADK_RECORD_FileCacheInit

FILE_CACHE_ARG

2.3.14 FILE_SDCARD_ARG

Description

Define the sdcard attribute structure.

Definition

typedef struct _FILE_SDCARD_ARG {
    FILE_CACHE_SDCARD_LOCK lock;
    FILE_CACHE_SDCARD_UNLOCK unlock;
    FILE_CACHE_MOUMNT_SDCARD mount_sdcard;
    FILE_CACHE_UMOUMNT_SDCARD umount_sdcard;
} FILE_SDCARD_ARG;

Members

Related data types and interfaces

FILE_CACHE_ARG

2.3.15 RKADK_POST_ISP_ATTR_S

Description

Define the post AI ISP attribute structure.

Definition

typedef struct {
  AIISP_CALLBACK_FUNC_S stAiIspCallback;      /* post isp callback function */
  const RK_CHAR        *pModelFilePath;       /* post isp model file path   */
  RK_U32                u32FrameBufCnt;       /* RW; frame buffer cnt    */
} RKADK_POST_ISP_ATTR_S;

Members

Related data types and interfaces

RKADK_MEDIA_EnablePostIsp RKADK_MEDIA_SetPostIspAttr

2.3.16 RKADK_AOV_ATTR_S

Description

Define the AOV attribute structure.

Definition

typedef struct {
  RKADK_ISP_WAKE_UP_PAUSE_FN pfnSingleFrame;
  RKADK_ISP_WAKE_UP_RESUME_FN pfnMultiFrame;
} RKADK_AOV_ATTR_S;

Members

Related Data Types and Interfaces

RKADK_RECORD_Create

2.3.17 RKADK_PIP_ATTR_S

Description

Define the structure for picture-in-picture attributes.

Definition

typedef struct {
  RKADK_BOOL bEnablePip;                      /* enable picture-in-picture */
  RKADK_U32 u32AvsGrpId;                      /* AVS group id [0, AVS_MAX_GRP_NUM)] */
  RKADK_U32 u32AvsBufCnt;                     /* default 2, min value 2 */
  RKADK_U32 u32SubCamId;                      /* subwindow camera id */
  RKADK_STREAM_TYPE_E enSubStreamType;        /* subwindow stream type */
  RKADK_RECT_S stSubRect;                     /* The subwindow is based on the display area
of the main window */
} RKADK_PIP_ATTR_S;

Members

Related Data Types and Interfaces

RKADK_RECORD_Create RKADK_RECORD_SetPipAttr

3. Muxer

This section provides basic muxer functionality, offering the following features to the product layer: Creation and destruction of muxer. Starting and stopping of muxer. Manual file splitting Each muxer supports the simultaneous packaging of up to two files. Each muxer file includes at least one video stream, with a maximum support of packaging one video stream and one audio stream simultaneously. Multiple muxer can be created at the same time. Supports third-party stream packaging.

3.1 API Reference

3.1.1 RKADK_MUXER_Create

Description

Create a muxer.

Syntax

RKADK_S32 RKADK_MUXER_Create(RKADK_MUXER_ATTR_S *pstMuxerAttr, RKADK_MW_PTR *ppHandle);

Parameters

Return Values

Requirements

Header file: rkadk_muxer.h Library file: librkadk.so

Notes

Creating the same muxer repeatedly is not supported. After creating the muxer, you must call RKADK_MUXER_Enable to enable the muxer, and then call RKADK_MUXER_Start to start the muxer.

Example

rkadk_muxer_test.

Related Topics

RKADK_MUXER_Destroy.

3.1.2 RKADK_MUXER_Destroy

Description

Destroy the muxer.

Syntax

RKADK_S32 RKADK_MUXER_Destroy(RKADK_MW_PTR pHandle);

Parameters

Return Values

Requirements

Header file: rkadk_muxer.h Library file: librkadk.so

Notes

Only created muxers can be destroyed; repeated destruction of the same muxer is not supported. Before destroying the muxer, you must first call RKADK_MUXER_Stop to stop the muxer, and then call RKADK_MUXER_Disable to disable the muxer.

Example

rkadk_muxer_test.

Related Topics

RKADK_MUXER_Create

3.1.3 RKADK_MUXER_Enable

Description

Enable the muxer.

Syntax

RKADK_S32 RKADK_MUXER_Enable(RKADK_MUXER_ATTR_S *pstMuxerAttr, RKADK_MW_PTR pHandle);

Parameters

Return Values

Requirements

Header file: rkadk_muxer.h Library file: librkadk.so

Notes

Use in conjunction with RKADK_MUXER_Disable.

Example

rkadk_muxer_test.

Related Topics

RKADK_MUXER_Disable.

3.1.4 RKADK_MUXER_Disable

Description

Disable the muxer.

Syntax

RKADK_S32 RKADK_MUXER_Disable(RKADK_MW_PTR pHandle);

Parameters

Return Values

Requirements

Header file: rkadk_muxer.h Library file: librkadk.so

Notes

Used in conjunction with RKADK_MUXER_Enable.

Example

rkadk_muxer_test.

Related Topics

RKADK_MUXER_Enable

3.1.5 RKADK_MUXER_Start

Description

Initialize the muxer.

Syntax

RKADK_S32 RKADK_MUXER_Start(RKADK_MW_PTR pHandle);

Parameters

Return Values

Requirements

Header file: rkadk_muxer.h Library file: librkadk.so

Notes

Muxer can be restarted after being stopped.

Example

rkadk_muxer_test.

Related Topics

RKADK_MUXER_Stop

3.1.6 RKADK_MUXER_Stop

Description

Stop the muxer.

Syntax

RKADK_S32 RKADK_MUXER_Stop(RKADK_MW_PTR pHandle);

Parameters

Return Values

Requirements

Header file: rkadk_muxer.h Library file: librkadk.so

Notes

Repeated stopping of the same muxer is not supported.

Example

rkadk_muxer_test.

Related Topics

RKADK_MUXER_Start

3.1.7 RKADK_MUXER_Single_Start

Description

Starts the specified stream’s muxer.

Syntax

RKADK_S32 RKADK_MUXER_Single_Start(RKADK_MW_PTR pHandle, int s32MuxerId, int s32VencChn);

Parameters

Return Values

Requirements

Header file: rkadk_muxer.h Library file: librkadk.so

Notes

Used in conjunction with RKADK_MUXER_Single_Stop. Supports restarting the muxer after it has been stopped.

Example

rkadk_muxer_test.

Related Topics

RKADK_MUXER_Single_Stop

3.1.8 RKADK_MUXER_Single_Stop

Description

Stop the specified stream’s muxer.

Syntax

RKADK_S32 RKADK_MUXER_Single_Stop(RKADK_MW_PTR pHandle, int s32MuxerId, int s32VencChn);

Parameters

Return Values

Requirements

Header file: rkadk_muxer.h Library file: librkadk.so

Notes

Use in conjunction with RKADK_MUXER_Single_Start. Does not support stopping the same muxer repeatedly.

Example

rkadk_muxer_test.

Related Topics

RKADK_MUXER_Single_Start

3.1.9 RKADK_MUXER_ManualSplit

Description

Manually split files.

Syntax

RKADK_S32 RKADK_MUXER_ManualSplit(RKADK_MW_PTR pHandle, RKADK_MUXER_MANUAL_SPLIT_ATTR_S *pstSplitAttr);

Parameters

Return Values

Requirements

Header file: rkadk_muxer.h Library file: librkadk.so

Notes

Supports repeatedly manually splitting files before the manual splitting is completed.

Example

rkadk_muxer_test

3.1.10 RKADK_MUXER_Reset

Description

Reset the muxer.

Syntax

RKADK_S32 RKADK_MUXER_Reset(RKADK_MW_PTR pHandle);

Parameters

Return Values

Requirements

Header file: rkadk_muxer.h Library file: librokadk.so

Notes

Before calling RKADK_MUXER_Reset, first call RKADK_MUXER_SetResetState to set the muxer to reset state; after RKADK_MUXER_Reset, you need to call RKADK_MUXER_ResetParam to reconfigure the muxer parameters; after RKADK_MUXER_ResetParam, call RKADK_MUXER_SetResetState again to set the muxer to a non-reset state.

Example

rkadk_muxer_test.

Related Topics

RKADK_MUXER_ResetParam RKADK_MUXER_SetResetState

3.1.11 RKADK_MUXER_ResetParam

Description

Reconfigure the muxer parameters.

Syntax

RKADK_S32 RKADK_MUXER_ResetParam(RKADK_MUXER_ATTR_S *pstMuxerAttr, RKADK_MW_PTR pHandle);

Parameters

Return Values

Requirements

Header file: rkadk_muxer.h Library file: librkadk.so

Example

rkadk_muxer_test.

Related Topics

RKADK_MUXER_Reset RKADK_MUXER_SetResetState

3.1.12 RKADK_MUXER_SetResetState

Description

Set the muxer reset state.

Syntax

void RKADK_MUXER_SetResetState(RKADK_MW_PTR pHandle, bool state);

Parameters

Requirements

Header file: rkadk_muxer.h Library file: librkadk.so

Example

rkadk_muxer_test.

Related Topics

RKADK_MUXER_Reset RKADK_MUXER_ResetParam

3.1.13 RKADK_MUXER_BuildInThumb

Description

Build-in thumbnails into files.

Syntax

RKADK_S32 RKADK_MUXER_BuildInThumb(RKADK_MW_PTR pHandle, RKADK_MUXER_THUMB_INFO_S stThumbInfo);

Parameters

Requirements

Header file: rkadk_muxer.h Library file: librkadk.so

Notes

If you need to build-in thumbnails into files, RKADK_MUXER_Create should be properly configured with thumbnail resolution to reserve space for thumbnail storage. Only MP4 files support build-in thumbnails.

Example

rkadk_muxer_test.

3.1.14 RKADK_MUXER_WriteVideoFrame

Description

Writing video stream data.

Syntax

int RKADK_MUXER_WriteVideoFrame(RKADK_MUXER_DATA_S stData, void *handle);

Parameters

Return Values

Requirements

Header file: rkadk_muxer.h Library file: librkadk.so

Example

rkadk_muxer_test.

3.1.15 RKADK_MUXER_WriteAudioFrame

Description

Writing audio stream data.

Syntax

int RKADK_MUXER_WriteAudioFrame(RKADK_MUXER_DATA_S stData, void *handle);

Parameters

Return Values

Requirements

Header file: rkadk_muxer.h Library file: librkadk.so

Example

rkadk_muxer_test.

3.2 Data Types

The Muxer module primarily provides the following data types: RKADK_MUXER_FILE_TYPE_E: Muxer file types RKADK_MUXER_EVENT_E: Muxer event types RKADK_MUXER_FILE_EVENT_INFO_S: Structure for file-related event information RKADK_MUXER_EVENT_INFO_S: Structure for muxer event information RKADK_MUXER_EVENT_CALLBACK_FN: Pointer to event callback function RKADK_MUXER_MANUAL_SPLIT_ATTR_S: Structure for manual split attributes RKADK_MUXER_MANUAL_SPLIT_TYPE_E: Manually split enumeration types RKADK_MUXER_ATTR_S: Structure for muxer attributes RKADK_MUXER_REC_TYPE_E: Muxer recording types RKADK_MUXER_TYPE_E: Muxer types RKADK_MUXER_REQUEST_FILE_NAME_CB: Pointer to function requesting file names RKADK_MUXER_STREAM_ATTR_S: Structure for muxer stream attributes RKADK_MUXER_PRE_RECORD_ATTR_S: Structure for pre-record attributes RKADK_MUXER_PRE_RECORD_MODE_E: Pre-record mode enumeration RKADK_MUXER_PTS_CALLBACK_FN: Pointer to video frame timestamp callback function RKADK_MUXER_PTS_INFO_S: Structure for timestamp information RKADK_MUXER_DATA_S: Structure for packaging data RKADK_MUXER_THUMB_INFO_S: Structure for thumbnail information RKADK_THIRD_MUXER_ATTR_S: Third party Muxer attributes

3.2.1 RKADK_MUXER_FILE_TYPE_E

Description

Defines the enumeration of muxer file types.

Definition

typedef enum rkMUXER_TYPE_E {
  RKADK_MUXER_TYPE_MP4 = 0,
  RKADK_MUXER_TYPE_MPEGTS,
  RKADK_MUXER_TYPE_FLV,
  RKADK_MUXER_TYPE_BUTT
} RKADK_MUXER_FILE_TYPE_E;

Members

Notes

Only MP4 files support build-in thumbnails.

3.2.2 RKADK_MUXER_EVENT_E

Description

Define the Muxer event enumeration type.

Definition

typedef enum rkMUXER_EVENT_E {
  RKADK_MUXER_EVENT_STREAM_START = 0,
  RKADK_MUXER_EVENT_STREAM_STOP,
  RKADK_MUXER_EVENT_FILE_BEGIN,
  RKADK_MUXER_EVENT_FILE_END,
  RKADK_MUXER_EVENT_MANUAL_SPLIT_END,
  RKADK_MUXER_EVENT_ERR_CREATE_FILE_FAIL,
  RKADK_MUXER_EVENT_ERR_WRITE_FILE_FAIL,
  RKADK_MUXER_EVENT_FILE_WRITING_SLOW,
  RKADK_MUXER_EVENT_ERR_CARD_NONEXIST,
  RKADK_MUXER_EVENT_BUTT
} RKADK_MUXER_EVENT_E;

Members

Related data types and interfaces

RKADK_MUXER_EVENT_INFO_S

3.2.3 RKADK_MUXER_FILE_EVENT_INFO_S

Description

Define file-related event information structure.

Definition

typedef struct {
  RK_CHAR asFileName[RKADK_MUXER_FILE_NAME_LEN];
  RK_U32 u32Duration; // ms
} RKADK_MUXER_FILE_EVENT_INFO_S;

Members

Related data types and interfaces

RKADK_MUXER_EVENT_INFO_S

3.2.4 RKADK_MUXER_EVENT_INFO_S

Description

Define the muxer event information structure.

Definition

typedef struct {
  RKADK_MUXER_EVENT_E enEvent;
  union {
    RKADK_MUXER_FILE_EVENT_INFO_S stFileInfo;
    RKADK_MUXER_ERROR_EVENT_INFO_S stErrorInfo;
  } unEventInfo;
} RKADK_MUXER_EVENT_INFO_S;

Members

Related data types and interfaces

RKADK_MUXER_EVENT_E RKADK_MUXER_FILE_EVENT_INFO_S

3.2.5 RKADK_MUXER_EVENT_CALLBACK_FN

Description

Define the muxer event callback function pointer.

Definition

typedef RKADK_VOID (*RKADK_MUXER_EVENT_CALLBACK_FN)(RKADK_MW_PTR pRecorder, const
RKADK_MUXER_EVENT_INFO_S *pstEventInfo);

Related data types and interfaces

RKADK_MUXER_EVENT_INFO_S

3.2.6 RKADK_REC_MANUAL_SPLIT_ATTR_S

Description

Define manually split attribute structure.

Definition

typedef struct {
  RKADK_MUXER_MANUAL_SPLIT_TYPE_E enManualType;               /* maual split type */
  RKADK_U32 u32DurationSec; /* file duration of manual split file */
} MUXER_MANUAL_SPLIT_ATTR_S;

Members

Related data types and interfaces

RKADK_MUXER_MANUAL_SPLIT_TYPE_E RKADK_MUXER_ManualSplit

3.2.7 RKADK_MUXER_MANUAL_SPLIT_TYPE_E

Description

Define manual split type.

Definition

typedef enum {
  MUXER_PRE_MANUAL_SPLIT,      /* pre manual split type */
  MUXER_NORMAL_MANUAL_SPLIT,   /* normal manual split type */
} RKADK_MUXER_MANUAL_SPLIT_ATTR_S;

Members

Related data types and interfaces

RKADK_REC_MANUAL_SPLIT_ATTR_S

3.2.8 RKADK_THIRD_MUXER_ATTR_S

Description

Defines the structure of the third party muxer attributes.

Definition

typedef struct {
  RKADK_THIRD_MUXER_INIT_FN pfnMuxerInit;
  RKADK_THIRD_MUXER_DEINIT_FN pfnMuxerDeinit;
  RKADK_THIRD_MUXER_WRITE_VIDEO_FN pfnWriteVideo;
  RKADK_THIRD_MUXER_WRITE_AUDIO_FN pfnWriteAudio;
  RKADK_THIRD_MUXER_GET_THUMB_POS_FN pfnGetThumbPos;
} RKADK_THIRD_MUXER_ATTR_S;

Members

Notes

Enable third-party Muxer, it is not supported to use RKADK_GetthmInMp4 and RKADK_GetthmInMp4Ex to obtain video thumbnails.

Related data types and interfaces

RKADK_MUXER_ATTR_S

3.2.9 RKADK_MUXER_ATTR_S

Description

Defines the structure of the muxer attributes.

Definition

typedef struct {
  RKADK_U32 u32CamId;
  RKADK_MUXER_REC_TYPE_E enRecType;
  RKADK_MUXER_TYPE_E enMuxerType;
  RKADK_U32 u32StreamCnt; /* stream cnt */
  RKADK_U32 u32FragKeyFrame;
  RKADK_MUXER_STREAM_ATTR_S
  astStreamAttr[RKADK_MUXER_STREAM_MAX_CNT]; /* array of stream attr */
  RKADK_MUXER_PRE_RECORD_ATTR_S stPreRecordAttr;
  RKADK_MUXER_REQUEST_FILE_NAME_CB pcbRequestFileNames;
  RKADK_MUXER_EVENT_CALLBACK_FN pfnEventCallback;
  RKADK_MUXER_PTS_CALLBACK_FN pfnPtsCallback;
  RKADK_AOV_ATTR_S stAovAttr;
  RKADK_MOUMNT_SDCARD_FN pfnMountSdcard;
  bool bEnableAiisp;
  RKADK_THIRD_MUXER_ATTR_S *pstThirdMuxerAttr;         /* third party muxer attr */
} RKADK_MUXER_ATTR_S;

Members

Related Data Types and Interfaces

RKADK_MUXER_REC_TYPE_E RKADK_MUXER_TYPE_E RKADK_MUXER_STREAM_ATTR_S RKADK_MUXER_PRE_RECORD_ATTR_S RKADK_MUXER_REQUEST_FILE_NAME_CB

RKADK_MUXER_EVENT_CALLBACK_FN RKADK_MUXER_PTS_CALLBACK_FN RKADK_AOV_ATTR_S RKADK_MOUMNT_SDCARD_FN RKADK_THIRD_MUXER_ATTR_S RKADK_MUXER_Create RKADK_MUXER_ResetParam

3.2.10 RKADK_MUXER_REC_TYPE_E

Description

Define the enumeration of muxer recording types.

Definition

typedef enum {
  RKADK_REC_TYPE_NORMAL = 0, /* normal record */
  RKADK_REC_TYPE_LAPSE,      /* time lapse record */
  RKADK_REC_TYPE_AOV_LAPSE,  /* low power time lapse record */
  RKADK_REC_TYPE_BUTT
} RKADK_MUXER_REC_TYPE_E;

Members

Related data types and interfaces

None Note Only RV1126 and RV1106 and RV1126B platforms support AOV time-lapse record

3.2.11 RKADK_MUXER_TYPE_E

Description

Defines the enumeration of muxer types.

Definition

typedef enum {
  RKADK_MUXER_TYPE_RECORD = 0,
  RKADK_MUXER_TYPE_THIRD_STREAM,
} RKADK_MUXER_TYPE_E;

Members

Related Data Types and Interfaces

RKADK_MUXER_ATTR_S

3.2.12 RKADK_MUXER_REQUEST_FILE_NAME_CB

Description

Defines the callback function pointer for requesting file names.

Definition

typedef int (*RKADK_MUXER_REQUEST_FILE_NAME_CB)(void *pHandle, char *pcFileName, unsigned
int u32MuxerId);

Members

Related Data Types and Interfaces

RKADK_MUXER_ATTR_S

3.2.13 RKADK_MUXER_PTS_CALLBACK_FN

Description

Defines the callback function pointer for video frame timestamps.

Definition

typedef RKADK_VOID (*RKADK_MUXER_PTS_CALLBACK_FN)(const RKADK_MUXER_PTS_INFO_S *pstPtsInfo);

Members

Related Data Types and Interfaces

RKADK_MUXER_PTS_INFO_S RKADK_MUXER_ATTR_S

3.2.14 RKADK_MUXER_PTS_INFO_S

Description

Defines the structure for timestamp information.

Definition

typedef struct {
  RKADK_U32 u32CamId;
  RKADK_S32 s32MuxerId;
  RKADK_U32 u32ChnId;
  RKADK_U64 u64PTS;
  RKADK_U32 u32Seq;
  const char *pFileName;
} RKADK_MUXER_PTS_INFO_S;

Members

Related Data Types and Interfaces

RKADK_MUXER_PTS_CALLBACK_FN

3.2.15 RKADK_MUXER_STREAM_ATTR_S

Description

Defines the structure for muxer stream attributes.

Definition

typedef struct {
  RKADK_S32 s32MuxerId;
  /* If it is a third-party stream that is not Rockit(such as a network stream),
    * s32ViChn/s32VencChn must set to -1.
  */
  RKADK_S32 s32ViChn;
  RKADK_S32 s32VencChn;
  RKADK_S32 s32ThumbVencChn;
  bool bUseVpss;
  RKADK_U32 u32TimeLenSec; /* record time */
  RKADK_PIP_ATTR_S stPipAttr;
  RKADK_U32 u32GetThumbTime;
  RKADK_U32 u32TrackCnt;   /* track cnt*/
  RKADK_MUXER_TRACK_SOURCE_S
  aHTrackSrcHandle[RKADK_MUXER_TRACK_MAX_CNT]; /* array of track source cnt */
  RKADK_MUXER_FILE_TYPE_E enType;
} RKADK_MUXER_STREAM_ATTR_S;

Members

Related Data Types and Interfaces

RKADK_MUXER_TRACK_SOURCE_S RKADK_MUXER_FILE_TYPE_E

3.2.16 RKADK_MUXER_TRACK_SOURCE_S

Description

Defines the structure for muxer stream attributes.

Definition

typedef struct {
  RKADK_TRACK_SOURCE_TYPE_E enTrackType;
  union {
    RKADK_TRACK_VIDEO_SOURCE_INFO_S stVideoInfo; /* <video track info */
    RKADK_TRACK_AUDIO_SOURCE_INFO_S stAudioInfo; /* <audio track info */
  } unTrackSourceAttr;
} RKADK_MUXER_TRACK_SOURCE_S;

Members

Related Data Types and Interfaces

RKADK_TRACK_SOURCE_TYPE_E RKADK_TRACK_VIDEO_SOURCE_INFO_S RKADK_TRACK_AUDIO_SOURCE_INFO_S

3.2.17 RKADK_TRACK_SOURCE_TYPE_E

Description

Defines the enumeration type for muxer stream tracks.

Definition

typedef enum {
  RKADK_TRACK_SOURCE_TYPE_VIDEO = 0,
  RKADK_TRACK_SOURCE_TYPE_AUDIO,
  RKADK_TRACK_SOURCE_TYPE_BUTT
} RKADK_TRACK_SOURCE_TYPE_E;

Members

3.2.18 RKADK_TRACK_VIDEO_SOURCE_INFO_S

Description

Defines the structure muxer video stream attributes.

Definition

typedef struct {
  RKADK_CODEC_TYPE_E enCodecType;
  RKADK_CHAR cPixFmt[RKADK_PIX_FMT_LEN];
  RKADK_U32 u32Width;
  RKADK_U32 u32Height;
  RKADK_U32 u32BitRate;
  RKADK_U32 u32FrameRate;
  RKADK_U32 u32Gop;
  RKADK_U16 u16Profile;
  RKADK_U16 u16Level;
  RKADK_U32 u32ThumbWidth;
  RKADK_U32 u32ThumbHeight;
} RKADK_TRACK_VIDEO_SOURCE_INFO_S;

Members

3.2.19 RKADK_TRACK_AUDIO_SOURCE_INFO_S

Description

Defines the structure for muxer audio stream attributes.

Definition

typedef struct {
  RKADK_CODEC_TYPE_E enCodecType;
  RKADK_U16 u32BitWidth;
  RKADK_U32 u32ChnCnt;
  RKADK_U32 u32SampleRate;
  RKADK_U32 u32SamplesPerFrame;
  RKADK_U32 u32Bitrate;
} RKADK_TRACK_AUDIO_SOURCE_INFO_S;

Members

3.2.20 RKADK_MUXER_PRE_RECORD_ATTR_S

Description

Defines the structure for pre-record attributes.

Definition

typedef struct {
  RKADK_U32 u32PreRecTimeSec; /* pre record time, unit in second(s) */
  RKADK_U32 u32PreRecCacheTime;
  RKADK_MUXER_PRE_RECORD_MODE_E enPreRecordMode;
} RKADK_MUXER_PRE_RECORD_ATTR_S;

Members

Related Data Types and Interfaces

RKADK_MUXER_PRE_RECORD_MODE_E RKADK_MUXER_ATTR_S

Notes

u32PreRecCacheTime must be greater than or equal to u32PreRecTimeSec and include a complete GoP to correctly obtain the I-frame.

3.2.21 RKADK_MUXER_PRE_RECORD_MODE_E

Description

Defines the enumeration type for pre-record modes.

Definition

typedef enum {
  RKADK_MUXER_PRE_RECORD_NONE = 0,
  RKADK_MUXER_PRE_RECORD_MANUAL_SPLIT, /* manual split file prerecord */
  RKADK_MUXER_PRE_RECORD_SINGLE        /* first file prerecord */
} RKADK_MUXER_PRE_RECORD_MODE_E;

Members

3.2.22 RKADK_MUXER_DATA_S

Description

Defines the muxer data structure.

Definition

typedef struct {
  RKADK_S32 s32MuxerId;
  RKADK_S32 s32VencChn;
  int isKeyFrame;
  RKADK_U64 u64Pts;
  RKADK_U32 u32Seq;
  RKADK_U32 u32Len;
  MB_BLK pMbBlk;
} RKADK_MUXER_DATA_S;

Members

Related Data Types and Interfaces

RKADK_MUXER_WriteVideoFrame RKADK_MUXER_WriteAudioFrame

3.2.23 RKADK_MUXER_THUMB_INFO_S

Description

Defines the thumbnail information structure.

Definition

typedef struct {
  RKADK_S32 s32MuxerId;
  unsigned char* pBuf;
  RKADK_U32 u32Len;
} RKADK_MUXER_THUMB_INFO_S;

Members

Related Data Types and Interfaces

RKADK_MUXER_BuildInThumb

4. AOV(Always On Video)

4.1 Overview

AOV (Always On Video) is a low frame rate continuous recording based on sleep&wake-up. It can switch back to the normal frame rate mode when there is an event, such as AI detection, PIR trigger, WIFI wake-up, etc. It is recommended to enable the file cache function when using AOV. For file cache usage, please refer to the RKADK_RECORD_FileCacheInit and RKADK_RECORD_FileCacheDeInit APIs in the recording chapter of this document. In order to reduce power consumption in the AOV time-lapse recording mode, the sdcard needs to be powered off after sleeping, and the sdcard must be unmounted before the application goes to sleep. When the file cache is enabled, the file cache will try to mount the sdcard when writing files, and perform file write protection, to ensure that the sdcard will not be unmounted during the file writing process. The AOV process is shown in the figure below:

4.2 API Reference

4.2.1 RKADK_AOV_Init

Description

AOV initialization.

Grammar

int RKADK_AOV_Init(RKADK_AOV_ARG_S *pstAovAttr);

Parameter

Return value

Requirement

Header file: rkadk_aov.h Library file: librkadk.so

Notice

It Must be used in conjunction with RKADK_AOV_DeInit. Repeated initialization is not supported.

Example

rkadk_aov_record_test

Related topic

RKADK_AOV_DeInit

4.2.2 RKADK_AOV_DeInit

Description

AOV deinitialization.

Grammar

int RKADK_AOV_DeInit();

Return value

Requirement

Header file: rkadk_aov.h Library file: librkadk.so

Notice

It Must be used in conjunction with RKADK_AOV_Init. Repeated deinitialization is not supported.

Example

rkadk_aov_record_test

Related topic

RKADK_AOV_Init

4.2.3 RKADK_AOV_SetSuspendTime

Description

Set the AOV scheduled sleep time in ms.

Grammar

int RKADK_AOV_SetSuspendTime(int u32WakeupSuspendTime);

Parameter

Return value

Requirement

Header file: rkadk_aov.h Library file: librkadk.so

Example

rkadk_aov_record_test

4.2.4 RKADK_AOV_EnterSleep

Description

Enter AOV.

Grammar

int RKADK_AOV_EnterSleep();

Return value

Requirement

Header file: rkadk_aov.h Library file: librkadk.so

Example

rkadk_aov_record_test

4.2.5 RKADK_AOV_WakeupLock

Description

Lock AOV related operations.

Grammar

void RKADK_AOV_WakeupLock();

Requirement

Header file: rkadk_aov.h Library file: librkadk.so

Notice

Must be used in conjunction with RKADK_AOV_WakeupUnlock.

Example

rkadk_aov_record_test

Related topic

RKADK_AOV_WakeupUnlock

4.2.6 RKADK_AOV_WakeupUnlock

Description

Unlocked AOV related operations.

Grammar

void RKADK_AOV_WakeupUnlock();

Requirement

Header file: rkadk_aov.h Library file: librkadk.so

Notice

Must be used in conjunction with RKADK_AOV_WakeupLock.

Example

rkadk_aov_record_test

Related topic

RKADK_AOV_WakeupLock

4.3 Type of data

The AOV module mainly provides the following data types: RKADK_AOV_ARG_S: AOV attribute structure RKADK_AOV_NOTIFY_CALLBACK: AOV notification callback function pointer

4.3.1 RKADK_AOV_ARG_S

Definition

Define the AOV attribute structure.

definition

typedef struct {
   RKADK_AOV_NOTIFY_CALLBACK pfnNotifyCallback;
} RKADK_AOV_ARG_S;

Members

[Related data types and interfaces] RKADK_AOV_Init RKADK_AOV_NOTIFY_CALLBACK

4.3.2 RKADK_AOV_NOTIFY_CALLBACK

Definition

Define the AOV notification callback function pointer.

Definition

typedef void (*RKADK_AOV_NOTIFY_CALLBACK)(RKADK_AOV_EVENT_E enEvent, void *msg);

Members

[Related data types and interfaces] RKADK_AOV_ARG_S RKADK_AOV_EVENT_E

4.3.3 RKADK_AOV_EVENT_E

Definition

Defines the AOV notification event enumeration.

definition

typedef enum {
   RKADK_AOV_ENTER_SLEEP = 0,
   RKADK_AOV_EVENT_BUTT
} RKADK_AOV_EVENT_E;

Members

[Related data types and interfaces]

RKADK_AOV_NOTIFY_CALLBACK

5. Photo

5.1 Overview

Provides basic snapshot functionality, offering JPEG encapsulation for capturing photos. The features include: Single snapshot Multiple snapshots JPEG Slice: Encodes VI data into JPEG in segments, which can save memory usage. When enlarging the JPEG, use interpolation algorithms to enlarge VI data in segments, and then encode it into JPEG in segments. Notice about JPEG Slice: Segment height requires alignment to 16 pixels. Considering the stitching effect of final images, it is recommended to keep the aspect ratio of the segmented image as consistent as possible with the original images. The more segments, the less memory required, but the image generation time increases. Conversely, when the number of segments decreases, the required memory increases, but the image generation speed accelerates; the actual number of segments depends on the actual situation.

5.2 API Reference

5.2.1 RKADK_PHOTO_Init

Description

The photo taking task is initialized.

Syntax

RKADK_S32 RKADK_PHOTO_Init(RKADK_PHOTO_ATTR_S *pstPhotoAttr, RKADK_MW_PTR *ppHandle);

Parameters

Return value

Requirement

Header file: rkadk_photo.h Library file: librkadk.so

Notice

Repeated initialization is not supported.

Example

rkadk_photo_test

See Also

RKADK_PHOTO_DeInit

5.2.2 RKADK_PHOTO_DeInit

Description

Deinitialize the photo taking task.

Syntax

RKADK_S32 RKADK_PHOTO_DeInit(RKADK_MW_PTR pHandle);

Parameters

Return value

Requirement

Header file: rkadk_photo.h Library file: librkadk.so

Notice

Repeated deinitialization is not supported.

Example

rkadk_photo_test

See Also

RKADK_PHOTO_DeInit

5.2.3 RKADK_PHOTO_TakePhoto

Description

Take Photos.

Syntax

RKADK_S32 RKADK_PHOTO_TakePhoto(RKADK_MW_PTR pHandle, RKADK_TAKE_PHOTO_ATTR_S *pstAttr);

Parameters

Return value

Requirement

Header file: rkadk_photo.h Library file: librkadk.so

Notice

The RKADK_PHOTO_TakePhoto interface can only be used after the recording task is initialized.

Example

rkadk_photo_test

See Also

No

5.2.4 RKADK_PHOTO_Reset

Description

Reconfigure the photo taking task.

Syntax

RKADK_S32 RKADK_PHOTO_Reset(RKADK_MW_PTR *ppHandle);

Parameters

Return value

Requirement

Header file: rkadk_photo.h Library file: librkadk.so

Notice

The RKADK_PHOTO_Reset interface can only be used after initializing the recording task. When switching resolution, reset the resolution of the Photo module in the ini file by using the RKADK_PARAM_SetCamParam API. RV1126/RV1109 and RK3576 does not support dynamic resolution switching. You need to RKADK_PHOTO_DeInit first, then configure the new resolution, and finally RKADK_PHOTO_Init again. If Photo and other modules share the VI channel, both the resolution of Photo and multiplex modules need to be switched simultaneously to avoid VI and VENC resolution mismatch.

Example

rkadk_photo_test

See Also

5.2.5 RKADK_PHOTO_GetThmInJpg

Description

Get thumbnail data from a JPG file.

Syntax

RKADK_S32 RKADK_PHOTO_GetThmInJpg(RKADK_U32 u32CamId, RKADK_CHAR *pszFileName, RKADK_JPG_THUMB_TYPE_E eThmType, RKADK_U8 *pu8Buf, RKADK_U32 *pu32Size);

Parameters

Return value

Requirement

Header file: rkadk_photo.h Library file: librkadk.so

Example

rkadk_thumb_test

See Also

No.

5.2.6 RKADK_PHOTO_GetThmInJpgEx

Description

JPG Thumbnail obtaining extended Interface: get thumbnail data from a JPG file, supporting the specification of the output thumbnail type and resolution. It must be used together with RKADK_PHOTO_ThumbBufFree.

Syntax

RKADK_S32 RKADK_PHOTO_GetThmInJpgEx(RKADK_U32 u32CamId, RKADK_CHAR *pszFileName, RKADK_JPG_THUMB_TYPE_E eThmType, RKADK_THUMB_ATTR_S *pstThumbAttr);

Parameters

Return value

Requirement

Header file: rkadk_photo.h Library file: librkadk.so

Example

rkadk_thumb_test

See Also

RKADK_PHOTO_ThumbBufFree

5.2.7 RKADK_PHOTO_ThumbBufFree

Description

Release the memory requested by RKADK_PHOTO_GetThmInJpgEx. It must be used together with RKADK_PHOTO_GetThmInJpgEx.

Syntax

RKADK_S32 RKADK_PHOTO_ThumbBufFree(RKADK_THUMB_ATTR_S *pstThumbAttr);

Parameters

Return value

Requirement

Header file: rkadk_photo.h Library file: librkadk.so

Example

rkadk_thumb_test

See Also

RKADK_PHOTO_GetThmInJpgEx

5.2.8 RKADK_MEDIA_SetVencRotation

Description

Set VENC channel rotation.

Syntax

RKADK_S32 RKADK_MEDIA_SetVencRotation(RKADK_U32 u32CamId, ROTATION_E enRotation, RKADK_STREAM_TYPE_E enStreamType);

Parameters

Return value

Requirement

Header file: rkadk_media_comm.h Library file: librkadk.so

5.2.9 RKADK_MEDIA_ToggleVencMirror

Description

Set VENC channel Mirror.

Syntax

RKADK_S32 RKADK_MEDIA_ToggleVencMirror(RKADK_U32 u32CamId, RKADK_STREAM_TYPE_E enStrmType, bool mirror);

Parameters

Return value

Requirement

Header file: rkadk_media_comm.h Library file: librkadk.so

5.2.10 RKADK_MEDIA_ToggleVencFlip

Description

Set VENC channel Flip.

Syntax

RKADK_S32 RKADK_MEDIA_ToggleVencFlip(RKADK_U32 u32CamId, RKADK_STREAM_TYPE_E enStrmType, bool flip);

Parameters

Return value

Requirement

Header file: rkadk_media_comm.h Library file: librkadk.so

5.3 Type of Data

The camera module mainly provides the following data types: RKADK_PHOTO_TYPE_E: Photo type enumeration RKADK_PHOTO_SINGLE_ATTR_S: Single snapshot attribute structure RKADK_PHOTO_MULTIPLE_ATTR_S: Multi snapshots attribute structure RKADK_PHOTO_RECV_DATA_S: Photo data structure RKADK_PHOTO_DATA_RECV_FN_PTR: Photo data receiving function pointer RKADK_TAKE_PHOTO_ATTR_S: Photo attribute structure RKADK_PHOTO_ATTR_S: Photo task attribute structure RKADK_JPG_THUMB_TYPE_E: JPG thumbnail type enumeration RKADK_THUMB_TYPE_E: Output thumbnail type enumeration RKADK_THUMB_ATTR_S: Thumbnail attribute structure ROTATION_E: Rotation type enumeration RKADK_PHOTO_FMT_CHANGE_S: Format conversion parameter structure, used for FBC0/NV16 format conversion

5.3.1 RKADK_PHOTO_TYPE_E

Description

Define the photo type enumeration.

Definition

typedef enum {
  RKADK_PHOTO_TYPE_SINGLE = 0,
  RKADK_PHOTO_TYPE_MULTIPLE,
  RKADK_PHOTO_TYPE_LAPSE, // TODO
  RKADK_PHOTO_TYPE_BUTT
} RKADK_PHOTO_TYPE_E;

Members

Related data types and interfaces

RKADK_TAKE_PHOTO_ATTR_S

5.3.2 RKADK_PHOTO_SINGLE_ATTR_S

Description

Define the single photo attribute structure.

Definition

typedef struct {
  // TODO
  RKADK_S32 s32Time_sec;
} RKADK_PHOTO_SINGLE_ATTR_S;

Members

Related data types and interfaces

RKADK_TAKE_PHOTO_ATTR_S

5.3.3 RKADK_PHOTO_MULTIPLE_ATTR_S

Description

Define the multi photos attribute structure.

Definition

typedef struct {
  /* s32Count is -1 that means continuous photo, larger than 0 that meas photo
   * number */
  RKADK_S32 s32Count;
} RKADK_PHOTO_MULTIPLE_ATTR_S;

Members

Related data types and interfaces

RKADK_TAKE_PHOTO_ATTR_SS

5.3.4 RKADK_PHOTO_THUMB_ATTR_S

Description

Define the thumbnail parameter attribute structure.

Definition

#define RKADK_MPF_LARGE_THUMB_NUM_MAX 2  /* Supports the maximum number of MPF thumbnails to
be generated simultaneously */

typedef struct rkSIZE_S {
  RK_U32 u32Width;               /* Thumbnail width*/
  RK_U32 u32Height;              /* Thumbnail height */
} SIZE_S;

typedef enum {
  RKADK_PHOTO_MPF_SINGLE = 0,    /* Single MPF thumbnail */
  RKADK_PHOTO_MPF_MULTI,         /* Multiple MPF thumbnails */
  RKADK_PHOTO_MPF_BUTT
} RKADK_PHOTO_MPF_MODE_E;

typedef struct {
  RKADK_U8 u8LargeThumbNum;      /* Number of generated MPF thumbnails*/
  SIZE_S astLargeThumbSize[RKADK_MPF_LARGE_THUMB_NUM_MAX];  /* Each thumbnail resolution */
} RKADK_PHOTO_MPF_CFG_S;
typedef struct {
  RKADK_PHOTO_MPF_MODE_E eMode;  /* MPF thumbnail mode */
  RKADK_PHOTO_MPF_CFG_S sCfg;    /* MPF thumbnail configuration */
} RKADK_PHOTO_MPF_ATTR_S;

typedef struct {
  RKADK_BOOL bSupportDCF; /* Fixed resolution: 160 * 120 jpg */
  RKADK_PHOTO_MPF_ATTR_S stMPFAttr;
} RKADK_PHOTO_THUMB_ATTR_S;

Members

Related data types and interfaces

RKADK_PHOTO_ATTR_S

5.3.5 RKADK_PHOTO_RECV_DATA_S

Description

Define the photo data structure.

Definition

typedef struct {
  RKADK_U8 *pu8DataBuf;
  RKADK_U32 u32DataLen;
  RKADK_U32 u32CamId;
  bool bStreamEnd;
  void *userdata;
} RKADK_PHOTO_RECV_DATA_S;

Members

Related data types and interfaces

RKADK_PHOTO_DATA_RECV_FN_PTR

5.3.6 RKADK_PHOTO_DATA_RECV_FN_PTR

Description

Define the camera data receiving function pointer.

Definition

typedef void (*RKADK_PHOTO_DATA_RECV_FN_PTR)(RKADK_PHOTO_RECV_DATA_S *pstData);

Members

Related data types and interfaces

RKADK_PHOTO_RECV_DATA_S RKADK_PHOTO_ATTR_S

5.3.7 RKADK_TAKE_PHOTO_ATTR_S

Description

Define the photo attribute structure.

Definition

typedef struct {
  RKADK_PHOTO_TYPE_E enPhotoType;
  union tagPhotoTypeAttr {
    RKADK_PHOTO_SINGLE_ATTR_S stSingleAttr;
    RKADK_PHOTO_LAPSE_ATTR_S stLapseAttr; // TODO
    RKADK_PHOTO_MULTIPLE_ATTR_S stMultipleAttr;
  } unPhotoTypeAttr;
} RKADK_TAKE_PHOTO_ATTR_S;

Members

Related data types and interfaces

RKADK_PHOTO_TYPE_E RKADK_PHOTO_SINGLE_ATTR_S RKADK_PHOTO_MULTIPLE_ATTR_S RKADK_PHOTO_TakePhoto

5.3.8 RKADK_PHOTO_FMT_CHANGE_S

Description

Define the format conversion parameter structure, used for FBC0/NV16 format conversion

Definition

typedef struct {
  RKADK_U32 u32VencChn;
  RKADK_U32 u32VdecChn;

  //format change venc parameter
  RKADK_U32 u32BitRate;   //default 4M
  RKADK_U32 u32Profile;   //default 77
} RKADK_PHOTO_FMT_CHANGE_S;

Members

Related Data Types and Interfaces

RKADK_PHOTO_ATTR_S RKADK_PHOTO_Init

5.3.9 RKADK_PHOTO_ATTR_S

Description

Define the photo task attribute structure.

Definition

typedef struct {
  RKADK_U32 u32CamId;
  RKADK_PHOTO_THUMB_ATTR_S stThumbAttr;
  RKADK_PHOTO_DATA_RECV_FN_PTR pfnPhotoDataProc;
  void *userdata;
  RKADK_POST_ISP_ATTR_S *pstPostIspAttr;
  RKADK_PHOTO_FMT_CHANGE_S stFmtChange;
} RKADK_PHOTO_ATTR_S;

Members

Related data types and interfaces

RKADK_PHOTO_THUMB_ATTR_S RKADK_PHOTO_DATA_RECV_FN_PTR RKADK_POST_ISP_ATTR_S RKADK_PHOTO_FMT_CHANGE_S RKADK_PHOTO_Init

5.3.10 RKADK_JPG_THUMB_TYPE_E

Description

Defines the JPG thumbnail type enumeration.

Definition

typedef enum {
  RKADK_JPG_THUMB_TYPE_DCF,
  RKADK_JPG_THUMB_TYPE_MFP1,
  RKADK_JPG_THUMB_TYPE_MFP2,
  RKADK_JPG_THUMB_TYPE_BUTT
} RKADK_JPG_THUMB_TYPE_E;

Members

Related data types and interfaces

RKADK_PHOTO_GetThmInJpg RKADK_PHOTO_GetThmInJpgEx

5.3.11 RKADK_THUMB_TYPE_E

Description

Defines the output thumbnail type enumeration.

Definition

typedef enum {
  RKADK_THUMB_TYPE_NV12 = 0,
  RKADK_THUMB_TYPE_JPEG,
  RKADK_THUMB_TYPE_RGB565,
  RKADK_THUMB_TYPE_RGBA8888,
  RKADK_THUMB_TYPE_BGRA8888
} RKADK_THUMB_TYPE_E;

Members

Related data types and interfaces

RKADK_THUMB_ATTR_S RKADK_GetThmInMp4Ex RKADK_PHOTO_GetThmInJpgEx

5.3.12 RKADK_THUMB_ATTR_S

Description

Define the thumbnail attribute structure.

Definition

typedef struct {
  RKADK_THUMB_TYPE_E enType;
  // 4 alignment
  RKADK_U32 u32Width;
  // 2 alignment
  RKADK_U32 u32Height;
  // 4 alignment
  RKADK_U32 u32VirWidth;
  // 2 alignment
  RKADK_U32 u32VirHeight;
  RKADK_U8 *pu8Buf;
  RKADK_U32 u32BufSize;
} RKADK_THUMB_ATTR_S;

Members

Related data types and interfaces

RKADK_THUMB_TYPE_E

RKADK_GetThmInMp4Ex RKADK_PHOTO_GetThmInJpgEx

5.3.13 ROTATION_E

Description

Defines an enumeration of rotation types.

Definition

typedef enum rkROTATION_E {
    ROTATION_0        = 0,
    ROTATION_90       = 1,
    ROTATION_180      = 2,
    ROTATION_270      = 3,
    ROTATION_BUTT
} ROTATION_E;

Related data types and interfaces

RKADK_MEDIA_SetVencRotation

6. Remote Preview

6.1 Overview

It provides callback interfaces for previewing to obtain Video and Audio information, start and stop VENC, start and stop AENC, and register functions for processing audio and video frame data.

6.2 API Reference

6.2.1 RKADK_STREAM_VideoInit

Description

Initialize Video module: VI, VENC.

Syntax

RKADK_S32 RKADK_STREAM_VideoInit(RKADK_STREAM_VIDEO_ATTR_S *pstVideoAttr, RKADK_MW_PTR *ppHandle);

Parameters

Return value

Requirement

Header file: rkadk_stream.h Library file: librkadk.so

Notice

Repeated initialization of the Video module is not supported.

Example

rkadk_stream_test

See Also

RKADK_STREAM_VideoDeInit

6.2.2 RKADK_STREAM_VideoDeInit

Description

Deinitialize Video modules: VI, VENC.

Syntax

RKADK_S32 RKADK_STREAM_VideoDeInit(RKADK_MW_PTR pHandle);

Parameters

Return value

Requirement

Header file: rkadk_stream.h Library file: librkadk.so

Notice

Repeated deinitialization is not supported.

Example

rkadk_stream_test

See Also

RKADK_STREAM_VideoInit

6.2.3 RKADK_STREAM_VencStart

Description

Enable VENC.

Syntax

RKADK_S32 RKADK_STREAM_VencStart(RKADK_MW_PTR pHandle, RKADK_S32 s32FrameCnt);

Parameters

Return value

Requirement

Header file: rkadk_stream.h Library file: librkadk.so

Notice

The RKADK_STREAM_VencStart interface can be called only after the Video module is initialized. After calling RKADK_STREAM_VencStart, trigger the VENC data callback function to start receiving data.

Example

rkadk_stream_test

See Also

RKADK_STREAM_VencStop

6.2.4 RKADK_STREAM_VencStop

Description

Disable VENC.

Syntax

RKADK_S32 RKADK_STREAM_VencStop(RKADK_MW_PTR pHandle);

Parameters

Return value

Requirement

Header file: rkadk_stream.h Library file: librkadk.so

Notice

None

Example

rkadk_stream_test

See Also

RKADK_STREAM_VencStart

6.2.5 RKADK_STREAM_VideoReset

Description

Reconfigure the stream video..

Syntax

RKADK_S32 RKADK_STREAM_VideoReset(RKADK_MW_PTR pHandle);

Parameters

Return value

Requirement

Header file: rkadk_stream.h Library file: librkadk.so

Notice

The RKADK_STREAM_VideoReset interface can only be used after RKADK_STREAM_VideoInit. When switching resolution, frame rate, bit rate, encoding type, or recording type, reset the parameters of the Preview module in the ini file by using the RKADK_PARAM_SetCamParam API. RV1126/RV1109 and RK3576 does not support dynamic switching of resolution and encoding type. You need to RKADK_STREAM_VideoDeInit first, then configure the new resolution or encoding type, and finally RKADK_STREAM_VideoInit again. If Preview and other modules share the VI channel, both the resolution of Preview and multiplexing modules need to be switched simultaneously to avoid VI and VENC resolution mismatch.

Example

rkadk_stream_test

6.2.6 RKADK_STREAM_GetVideoInfo

Description

Get Video information.

Syntax

RKADK_S32 RKADK_STREAM_GetVideoInfo(RKADK_U32 u32CamId, RKADK_VIDEO_INFO_S *pstVideoInfo);

Parameters

Return value

Requirement

Header file: rkadk_stream.h Library file: librkadk.so

Notice

None

Example

rkadk_stream_test

See Also

None

6.2.7 RKADK_STREAM_AudioInit

Description

Initialize Audio modules: AI, AENC.

Syntax

RKADK_S32 RKADK_STREAM_AudioInit(RKADK_STREAM_AUDIO_ATTR_S *pstAudioAttr, RKADK_MW_PTR *ppHandle);

Parameters

Return value

Requirement

Header file: rkadk_stream.h Library file: librkadk.so

Notice

Repeated initialization of the Audio module is not supported.

Example

rkadk_stream_test

See Also

RKADK_STREAM_AudioDeInit

6.2.8 RKADK_STREAM_AudioDeInit

Description

Deinitialize Audio modules: AI, AENC.

Syntax

RKADK_S32 RKADK_STREAM_AudioDeInit(RKADK_MW_PTR pHandle);

Parameters

Return value

Requirement

Header file: rkadk_stream.h Library file: librkadk.so

Notice

None

Example

rkadk_stream_test

See Also

RKADK_STREAM_AudioInit

6.2.9 RKADK_STREAM_AencStart

Description

Enable AENC.

Syntax

RKADK_S32 RKADK_STREAM_AencStart(RKADK_MW_PTR *pHandle);

Parameters

Return value

Requirement

Header file: rkadk_stream.h Library file: librkadk.so

Notice

The RKADK_STREAM_AencStart interface can be called only after the Audio module is initialized. After calling RKADK_STREAM_AencStart, trigger the AENC data callback function to start receiving data.

Example

rkadk_stream_test

See Also

RKADK_STREAM_AencStop

6.2.10 RKADK_STREAM_AencStop

Description

Disable AENC.

Syntax

RKADK_S32 RKADK_STREAM_AencStop(RKADK_MW_PTR *pHandle);

Parameters

Return value

Requirement

Header file: rkadk_stream.h Library file: librkadk.so

Notice

None

Example

rkadk_stream_test

See Also

RKADK_STREAM_AencStart

6.2.11 RKADK_STREAM_GetAudioInfo

Description

Get Audio information.

Syntax

RKADK_S32 RKADK_STREAM_GetAudioInfo(RKADK_MW_PTR *pHandle, RKADK_AUDIO_INFO_S *pstAudioInfo);

Parameters

Return value

Requirement

Header file: rkadk_stream.h Library file: librkadk.so

Notice

None

Example

rkadk_stream_test

See Also

None

6.3 Type of Data

The playback module mainly provides the following data types: RKADK_CODEC_TYPE_E: Encoding format enumeration RKADK_VENC_DATA_PROC_FUNC: VENC data callback function pointer RKADK_VIDEO_STREAM_S: Video data stream structure RKADK_VENC_DATA_PACK_S: VENC data packet structure RKADK_VENC_DATA_TYPE_S: VENC packet type RKADK_VIDEO_INFO_S: Video information structure RKADK_STREAM_VIDEO_ATTR_S: Video task attribute structure RKADK_AUDIO_DATA_PROC_FUNC: Audio data callback function pointer RKADK_AUDIO_STREAM_S: Audio data structure RKADK_AUDIO_INFO_S: Audio information structure RKADK_STREAM_AUDIO_ATTR_S: Audio task attribute structure

6.3.1 RKADK_CODEC_TYPE_E

Description

Define the encoding format enumeration type. Audio encoding does not support AAC by default.

Definition

typedef enum {
  //Video
  RKADK_CODEC_TYPE_H264 = 0,
  RKADK_CODEC_TYPE_H265,
  RKADK_CODEC_TYPE_MJPEG,
  RKADK_CODEC_TYPE_JPEG,

  //Audio
  RKADK_CODEC_TYPE_G711A,
  RKADK_CODEC_TYPE_G711U,
  RKADK_CODEC_TYPE_G726,
  RKADK_CODEC_TYPE_MP2,
  RKADK_CODEC_TYPE_MP3,
  RKADK_CODEC_TYPE_ACC,
  RKADK_CODEC_TYPE_PCM,
  RKADK_CODEC_TYPE_BUTT
} RKADK_CODEC_TYPE_E;

6.3.2 RKADK_VENC_DATA_PROC_FUNC

Description

Define the VENC data callback function pointer.

Definition

typedef RKADK_S32 (*RKADK_VENC_DATA_PROC_FUNC)(RKADK_VIDEO_STREAM_S *pVStreamData);

Related data types and interfaces

RKADK_VIDEO_STREAM_S

6.3.3 RKADK_VIDEO_STREAM_S

Description

Define the Video stream structure.

Definition

typedef struct {
  RKADK_VENC_DATA_PACK_S astPack; /* stream pack attribute */
  RKADK_U32 u32Seq;               /* the list number of stream */
  RKADK_BOOL bEndOfStream;        /* frame end flag */
  RKADK_U32 u32CamId;
} RKADK_VIDEO_STREAM_S;

Members

Related data types and interfaces

RKADK_VENC_DATA_PACK_S RKADK_VENC_DATA_PROC_FUNC

6.3.4 RKADK_VENC_DATA_PACK_S

Description

Define the VENC packet structure.

Definition

typedef struct {
  RKADK_U8 *apu8Addr;                /* the virtual address of stream */
  RKADK_U32 au32Len;                 /* the length of stream */
  RKADK_U64 u64PTS;                  /* time stamp */
  RKADK_VENC_DATA_TYPE_S stDataType; /* the type of stream */
} RKADK_VENC_DATA_PACK_S;

Members

Related data types and interfaces

RKADK_VENC_DATA_TYPE_S RKADK_VIDEO_STREAM_S

6.3.5 RKADK_VENC_DATA_TYPE_S

Description

Define VENC packet type.

Definition

/* the nalu type of H264 */
typedef enum {
  RKADK_H264E_NALU_BSLICE = 0,   /* B SLICE types */
  RKADK_H264E_NALU_PSLICE = 1,   /* P SLICE types */
  RKADK_H264E_NALU_ISLICE = 2,   /* I SLICE types */
  RKADK_H264E_NALU_IDRSLICE = 5, /* IDR SLICE types */
  RKADK_H264E_NALU_SEI = 6,      /* SEI types */
  RKADK_H264E_NALU_SPS = 7,      /* SPS types */
  RKADK_H264E_NALU_PPS = 8,      /* PPS types */
  RKADK_H264E_NALU_BUTT
} RKADK_H264E_NALU_TYPE_E;
/* the nalu type of H265 */
typedef enum {
  RKADK_H265E_NALU_BSLICE = 0,    /* B SLICE types */
  RKADK_H265E_NALU_PSLICE = 1,    /* P SLICE types */
  RKADK_H265E_NALU_ISLICE = 2,    /* I SLICE types */
  RKADK_H265E_NALU_IDRSLICE = 19, /* IDR SLICE types */
  RKADK_H265E_NALU_VPS = 32,      /* VPS types */
  RKADK_H265E_NALU_SPS = 33,      /* SPS types */
  RKADK_H265E_NALU_PPS = 34,      /* PPS types */
  RKADK_H265E_NALU_SEI = 39,      /* SEI types */
  RKADK_H265E_NALU_BUTT
} RKADK_H265E_NALU_TYPE_E;

typedef struct {
  RKADK_CODEC_TYPE_E enPayloadType;      /* H.264/H.265/JPEG/MJPEG */
  union {
    RKADK_H264E_NALU_TYPE_E enH264EType; /* H264E NALU types */
    RKADK_H265E_NALU_TYPE_E enH265EType; /* H265E NALU types */
    RKADK_JPEGE_PACK_TYPE_E enJPEGEType; /* TODO: JPEGE PACK types*/
  };
} RKADK_VENC_DATA_TYPE_S;

Members

Related data types and interfaces

RKADK_CODEC_TYPE_E RKADK_VENC_DATA_PACK_S

6.3.6 RKADK_VIDEO_INFO_S

Description

Define Video information structure.

Definition

typedef struct {
  RKADK_CODEC_TYPE_E enCodecType;
  RKADK_U32 u32Width;
  RKADK_U32 u32Height;
  RKADK_U32 u32BitRate;
  RKADK_U32 u32FrameRate;
  RKADK_U32 u32Gop;
} RKADK_VIDEO_INFO_S;

Members

Related data types and interfaces

RKADK_CODEC_TYPE_E RKADK_STREAM_GetVideoInfo

6.3.7 RKADK_STREAM_VIDEO_ATTR_S

Description

Define the Video task attribute structure.

Definition

typedef struct {
  RKADK_U32 u32CamId;
  RKADK_VENC_DATA_PROC_FUNC pfnDataCB;
} RKADK_STREAM_VIDEO_ATTR_S;

Members

Related data types and interfaces

RKADK_VENC_DATA_PROC_FUNC RKADK_STREAM_VideoInit

6.3.8 RKADK_AUDIO_DATA_PROC_FUNC

Description

Define the AENC data callback function pointer.

Definition

typedef RKADK_S32 (*RKADK_AUDIO_DATA_PROC_FUNC)(RKADK_AUDIO_STREAM_S *pAStreamData);

Related data types and interfaces

RKADK_AUDIO_STREAM_S

6.3.9 RKADK_AUDIO_STREAM_S

Description

Define the Audio data flow structure.

Definition

typedef struct {
  RKADK_U8 *pStream;      /* the virtual address of stream */
  RKADK_U32 u32Len;       /* stream lenth, by bytes */
  RKADK_U64 u64TimeStamp; /* frame time stamp */
  RKADK_U32 u32Seq;       /* frame seq, if stream is not a valid frame,u32Seq is 0 */
  RKADK_CODEC_TYPE_E enType;
} RKADK_AUDIO_STREAM_S;

Members

Related data types and interfaces

RKADK_AUDIO_DATA_PROC_FUNC

6.3.10 RKADK_AUDIO_INFO_S

Description

Define the Audio information structure.

Definition

typedef struct {
  RKADK_CODEC_TYPE_E enCodecType;
  RKADK_U32 u32ChnCnt;
  RKADK_U32 u32SampleRate;
  RKADK_U32 u32AvgBytesPerSec;
  RKADK_U32 u32SamplesPerFrame;
  RKADK_U16 u16SampleBitWidth;
} RKADK_AUDIO_INFO_S;

Members

Related data types and interfaces

RKADK_CODEC_TYPE_E RKADK_STREAM_GetAudioInfo

6.3.11 RKADK_STREAM_AUDIO_ATTR_S

Description

Define the Audio task attribute structure.

Definition

typedef struct {
  RKADK_U32 u32CamId;
  RKADK_CODEC_TYPE_E enCodecType;
  RKADK_AUDIO_DATA_PROC_FUNC pfnPcmDataCB;
  RKADK_AUDIO_DATA_PROC_FUNC pfnAencDataCB;
} RKADK_STREAM_AUDIO_ATTR_S;

Members

Related data types and interfaces

RKADK_AUDIO_DATA_PROC_FUNC RKADK_STREAM_AudioInit

7. Player

7.1 Overview

It provides local audio and video files, RTSP network stream playback functions, and supports basic playback control operations: play, pause, seek, and screen snapshot. The Player function is compatible with RV1109/RV1126, RV1103/RV1103, RK3308, and RK3506 platforms. RV1109/RV1126 uses hardware decoding, and other platforms use software decoding.

7.2 API Reference

7.2.1 RKADK_PLAYER_Create

Description

Create a player.

Syntax

RKADK_S32 RKADK_PLAYER_Create(RKADK_MW_PTR *ppPlayer, RKADK_PLAYER_CFG_S *pstPlayCfg);

Parameters

Return value

Requirement

Header file: rkadk_player.h Library file: librkadk.so

Notice

Repeated creation of the same player is not supported.

Example

rkadk_player_test

See Also

RKADK_PLAYER_Destroy

7.2.2 RKADK_PLAYER_Destroy

Description

Destroy the player.

Syntax

RKADK_S32 RKADK_PLAYER_Destroy(RKADK_MW_PTR pPlayer);

Parameters

Return value

Requirement

Header file: rkadk_player.h Library file: librkadk.so

Notice

Repeated destruction of the same player is not supported.

Example

rkadk_player_test

See Also

RKADK_PLAYER_Create

7.2.3 RKADK_PLAYER_SetDataSource

Description

Set the path of the file to be played. When Player enables the third-party demuxer library, RKADK_PLAYER_SetDataParam should be used.

Syntax

RKADK_S32 RKADK_PLAYER_SetDataSource(RKADK_MW_PTR pPlayer, const RKADK_CHAR *pszfilePath);

Parameters

Return value

Requirement

Header file: rkadk_player.h Library file: librkadk.so

Notice

The RKADK_PLAYER_SetDataSource interface can be called only after the player is created.

Example

rkadk_player_test

See Also

None

7.2.4 RKADK_PLAYER_SetDataParam

Description

Set the audio and video parameters of the file to be played. Use this interface when Player enables the third- party demuxer library, otherwise use RKADK_PLAYER_SetDataSource.

Syntax

RKADK_S32 RKADK_PLAYER_SetDataParam(RKADK_MW_PTR pPlayer, RKADK_PLAYER_DATA_PARAM_S *pstDataParam);

Parameters

Return value

Requirement

Header file: rkadk_player.h Library file: librkadk.so

Notice

The RKADK_PLAYER_SetDataParam interface can be called only after the player is created.

Example

rkadk_player_test

See Also

RKADK_PLAYER_SendAudioPacket RKADK_PLAYER_SendVideoPacket

7.2.5 RKADK_PLAYER_Prepare

Description

Ready to play.

Syntax

RKADK_S32 RKADK_PLAYER_Prepare(RKADK_MW_PTR pPlayer);

Parameters

Return value

Requirement

Header file: rkadk_player.h Library file: librkadk.so

Notice

The RKADK_PLAYER_Prepare interface can only be called after creating the player and setting the playback path.

Example

rkadk_player_test

See Also

None

7.2.6 RKADK_PLAYER_GetCurrentPosition

Description

Get the current playback progress.

Syntax

RKADK_S64 RKADK_PLAYER_GetCurrentPosition(RKADK_MW_PTR pPlayer);

Parameters

Return value

Requirement

Header file: rkadk_player.h

Library file: librkadk.so

Notice

None

Example

rkadk_player_test

See Also

None

7.2.7 RKADK_PLAYER_Play

Description

Start playing.

Syntax

RKADK_S32 RKADK_PLAYER_Play(RKADK_MW_PTR pPlayer);

Parameters

Return value

Requirement

Header file: rkadk_player.h Library file: librkadk.so

Notice

The RKADK_PLAYER_Play interface can be called only after calling RKADK_PLAYER_Prepare.

Example

rkadk_player_test

See Also

RKADK_PLAYER_Stop

7.2.8 RKADK_PLAYER_Stop

Description

Stop playback and release resources.

Syntax

RKADK_S32 RKADK_PLAYER_Stop(RKADK_MW_PTR pPlayer);

Parameters

Return value

Requirement

Header file: rkadk_player.h Library file: librkadk.so

Notice

None

Example

rkadk_player_test

See Also

RKADK_PLAYER_Play

7.2.9 RKADK_PLAYER_Pause

Description

Pause playback.

Syntax

RKADK_S32 RKADK_PLAYER_Pause(RKADK_MW_PTR pPlayer);

Parameters

Return value

Requirement

Header file: rkadk_player.h Library file: librkadk.so

Notice

None

Example

rkadk_player_test

See Also

RKADK_PLAYER_Play

7.2.10 RKADK_PLAYER_Seek

Description

Seek.

Syntax

RKADK_S32 RKADK_PLAYER_Seek(RKADK_MW_PTR pPlayer, RKADK_S64 s64TimeInMs);

Parameters

Return value

Requirement

Header file: rkadk_player.h Library file: librkadk.so

Notice

The RKADK_PLAYER_Seek interface can be called only after calling RKADK_PLAYER_Play.

Example

rkadk_player_test

See Also

RKADK_PLAYER_Play

7.2.11 RKADK_PLAYER_GetPlayStatus

Description

Get the current playback status.

Syntax

RKADK_S32 RKADK_PLAYER_GetPlayStatus(RKADK_MW_PTR pPlayer, RKADK_PLAYER_STATE_E *penState);

Parameters

Return value

Requirement

Header file: rkadk_player.h Library file: librkadk.so

Notice

None

Example

rkadk_player_test

See Also

None

7.2.12 RKADK_PLAYER_GetDuration

Description

Get the duration of current playing file.

Syntax

RKADK_S32 RKADK_PLAYER_GetDuration(RKADK_MW_PTR pPlayer, RKADK_U32 *pDuration);

Parameters

Return value

Requirement

Header file: rkadk_player.h Library file: librkadk.so

Notice

None

Example

rkadk_player_test

See Also

None

7.2.13 RKADK_PLAYER_Snapshot

Description

Player screenshot, calling this interface will encode the currently displayed picture into JPEG data. The application can obtain the generated JPEG data by registering the RKADK_PPLAYER_SNAPSHOT_RECV_FN callback.

Syntax

RKADK_S32 RKADK_PLAYER_Snapshot(RKADK_MW_PTR pPlayer);

Parameters

Return value

Requirement

Header file: rkadk_player.h Library file: librkadk.so

Example

rkadk_player_test

See Also

None

7.2.14 RKADK_PLAYER_SendAudioPacket

Description

When Player enables the third-party demuxer library, this interface is used to send de-capsulated audio data to Player for decoding and playback.

Syntax

RKADK_S32 RKADK_PLAYER_SendAudioPacket(RKADK_MW_PTR pPlayer, RKADK_PLAYER_PACKET *pstPacket);

Parameters

Return value

Requirement

Header file: rkadk_player.h Library file: librkadk.so

Notice

Before using this interface, you need to call RKADK_PLAYER_SetDataParam to set audio and video related parameters.

Example

rkadk_player_test

See Also

RKADK_PLAYER_SendVideoPacket RKADK_PLAYER_SetDataParam

7.2.15 RKADK_PLAYER_SendVideoPacket

Description

When Player enables the third-party demuxer library, this interface is used to send de-capsulated video data to Player for decoding and playback.

Syntax

RKADK_S32 RKADK_PLAYER_SendVideoPacket(RKADK_MW_PTR pPlayer, RKADK_PLAYER_PACKET *pstPacket);

Parameters

Return value

Requirement

Header file: rkadk_player.h Library file: librkadk.so

Notice

Before using this interface, you need to call RKADK_PLAYER_SetDataParam to set audio and video related parameters.

Example

rkadk_player_test

See Also

RKADK_PLAYER_SendAudioPacket RKADK_PLAYER_SetDataParam

7.2.16 RKADK_PLAYER_GetSendFrameNum

Description

Retrieve the number of frames that have been successfully decoded.

Syntax

RKADK_S32 RKADK_PLAYER_GetSendFrameNum(RKADK_MW_PTR pPlayer);

Parameters

Return Value

Requirements

Header file: rkadk_player.h

Library file: librkadk.so Note The count will be reset after Pause/Stop.

Example

rkadk_player_test

Related Topics

None

7.2.17 RKADK_PLAYER_SetVdecWaterline

Description

Set the VDEC waterline.

Syntax

RKADK_S32 RKADK_PLAYER_SetVdecWaterline(RKADK_MW_PTR pPlayer, RKADK_U32 u32VdecWaterline);

Parameters

Return Value

Requirements

Header file: rkadk_player.h Library file: librkadk.so Note After setting the VDEC waterline, playback will only start when the VDEC buffer reaches the waterline value.

Example

rkadk_player_test

Related Topics

None

7.2.18 RKADK_PLAYER_SetAoVolume

Description

Set playback volume.

Syntax

RKADK_S32 RKADK_PLAYER_SetAoVolume(RKADK_MW_PTR pPlayer, RKADK_S32 s32Volume);

Parameters

Return Values

Requirements

Header file: rkadk_player.h Library file: librkadk.so

Notes

None

Example

rkadk_player_test

Related Topics

None

7.3 Type of Data

The playback module mainly provides the following data types: RKADK_PLAYER_EVENT_E: Playback event enumeration type RKADK_PLAYER_EVENT_FN: Playback event callback function pointer

RKADK_PLAYER_CFG_S: Player attribute structure RKADK_VO_FORMAT_E: Image pixel format enumeration type RKADK_VO_INTF_TYPE_E: Display interface enumeration type RKADK_PLAYER_FRAME_INFO_S: Image information structure RKADK_PLAYER_STATE_E: Playback status enumeration type RKADK_PLAYER_DATA_PARAM_S: Audio and video parameter structure RKADK_PLAYER_PACKET: Player data packet structure RKADK_PLAYER_RTSP_CFG_S: RTSP attribute structure RKADK_PLAYER_VDEC_CFG_S: VDEC attribute structure RKADK_PLAYER_SNAPSHOT_CFG_S: Screenshot attribute structure RKADK_PLAYER_SNAPSHOT_S: Screenshot data structure RKADK_PPLAYER_SNAPSHOT_RECV_FN: Screenshot data callback function pointer

7.3.1 RKADK_PLAYER_EVENT_E

Description

Defines the playback event enumeration type.

Definition

typedef enum {
  RKADK_PLAYER_EVENT_STATE_CHANGED = 0x0,
  RKADK_PLAYER_EVENT_PREPARED,
  RKADK_PLAYER_EVENT_PLAY,
  RKADK_PLAYER_EVENT_PAUSED,
  RKADK_PLAYER_EVENT_STOPPED,
  RKADK_PLAYER_EVENT_EOF,
  RKADK_PLAYER_EVENT_SOF,
  RKADK_PLAYER_EVENT_SEEK_END,
  RKADK_PLAYER_EVENT_ERROR,
  RKADK_PLAYER_EVENT_BUTT
} RKADK_PLAYER_EVENT_E;

Members

Related data types and interfaces

RKADK_PLAYER_EVENT_FN

7.3.2 RKADK_PLAYER_EVENT_FN

Description

Define the playback event callback function pointer.

Definition

typedef RKADK_VOID (*RKADK_PLAYER_EVENT_FN)(RKADK_MW_PTR pPlayer, RKADK_PLAYER_EVENT_E
enEvent, RKADK_VOID *pData);

Members

Related data types and interfaces

RKADK_PLAYER_EVENT_E RKADK_PLAYER_CFG_S

7.3.3 RKADK_PLAYER_CFG_S

Description

Define the player attribute structure.

Definition

typedef struct {
  RKADK_BOOL bEnableVideo;
  RKADK_BOOL bEnableAudio;
  RKADK_BOOL bEnableThirdDemuxer;
  RKADK_PLAYER_FRAME_INFO_S stFrmInfo;
  RKADK_PLAYER_RTSP_CFG_S stRtspCfg;
  RKADK_PLAYER_VDEC_CFG_S stVdecCfg;
  RKADK_PLAYER_SNAPSHOT_CFG_S stSnapshotCfg;
  RKADK_BOOL bEnableBlackBackground;
  RKADK_PLAYER_EVENT_FN pfnPlayerCallback;
} RKADK_PLAYER_CFG_S;

Members

Related data types and interfaces

RKADK_PLAYER_EVENT_FN RKADK_PLAYER_FRAME_INFO_S RKADK_PLAYER_RTSP_CFG_S RKADK_PLAYER_VDEC_CFG_S RKADK_PLAYER_SNAPSHOT_CFG_S RKADK_PLAYER_Create

7.3.4 RKADK_VO_FORMAT_E

Description

Defines the image pixel format enumeration type.

Definition

typedef enum {
  VO_FORMAT_ARGB8888 = 0,
  VO_FORMAT_ABGR8888,
  VO_FORMAT_RGB888,
  VO_FORMAT_BGR888,
  VO_FORMAT_ARGB1555,
  VO_FORMAT_ABGR1555,
  VO_FORMAT_RGB565,
  VO_FORMAT_RGB444,
  VO_FORMAT_NV12,
  VO_FORMAT_NV21
} RKADK_VO_FORMAT_E;

Related data types and interfaces

RKADK_PLAYER_FRAME_INFO_S

7.3.5 RKADK_VO_INTF_TYPE_E

Description

Defines the display interface enumeration type.

Definition

typedef enum {
  DISPLAY_TYPE_HDMI = 0,
  DISPLAY_TYPE_EDP,
  DISPLAY_TYPE_VGA,
  DISPLAY_TYPE_DP,
  DISPLAY_TYPE_HDMI_EDP,
  DISPLAY_TYPE_MIPI,
  DISPLAY_TYPE_DEFAULT,
} RKADK_VO_INTF_TYPE_E;

Members

Related data types and interfaces

RKADK_PLAYER_FRAME_INFO_S

7.3.6 RKADK_VO_SPLICE_MODE_E

Description

Defines the layer splicing method enumeration type.

Definition

typedef enum {
  SPLICE_MODE_RGA = 0,
  SPLICE_MODE_GPU,
  SPLICE_MODE_BYPASS
} RKADK_VO_INTF_TYPE_E;

Members

Related data types and interfaces

RKADK_PLAYER_FRAME_INFO_S

7.3.7 RKADK_PLAYER_FRAME_INFO_S

Description

Define the image information structure.

Definition

typedef struct {
  RKADK_U32 u32FrmInfoX;
  RKADK_U32 u32FrmInfoY;
  RKADK_U32 u32DispWidth;
  RKADK_U32 u32DispHeight;
  RKADK_U32 u32ImgWidth;
  RKADK_U32 u32ImgHeight;
  RKADK_U32 u32VoLay;
  RKADK_U32 u32VoDev;
  RKADK_U32 u32VoChn;
  RKADK_U32 u32BorderColor;
  RKADK_U32 u32BorderTopWidth;
  RKADK_U32 u32BorderBottomWidth;
  RKADK_U32 u32BorderLeftWidth;
  RKADK_U32 u32BorderRightWidth;
  RKADK_BOOL bMirror;
  RKADK_BOOL bFlip;
  RKADK_U32 u32Rotation; //0: 0, 1: 90, 2: 180, 3: 270
  RKADK_VO_FORMAT_E u32VoFormat;
  RKADK_VO_INTF_TYPE_E u32EnIntfType;
  RKADK_VO_INTF_SYNC_E enIntfSync;
  RKADK_VO_SYNC_INFO_S stSyncInfo;
  RKADK_VO_SPLICE_MODE_E enVoSpliceMode;
} RKADK_PLAYER_FRAMEINFO_S;

Members

Notice

For detailed video output related attributes, please refer to the VO chapter of the Rockit document Rockchip_Developer_Guide_MPI.pdf.

Related data types and interfaces

RKADK_VO_FORMAT_E RKADK_VO_INTF_TYPE_E RKADK_VO_SPLICE_MODE_E

RKADK_PLAYER_Create

7.3.8 RKADK_PLAYER_STATE_E

Description

Defines the playback status enumeration type.

Definition

typedef enum {
  RKADK_PLAYER_STATE_IDLE = 0, /* The player state before init */
  RKADK_PLAYER_STATE_INIT,     /* The player is in the initial state. It changes
                                  to the initial state after being SetDataSource */
  RKADK_PLAYER_STATE_PREPARED, /* The player is in the prepared state */
  RKADK_PLAYER_STATE_PLAY,     /* The player is in the playing state */
  RKADK_PLAYER_STATE_TPLAY,    /* The player is in the trick playing state, Reserved */
  RKADK_PLAYER_STATE_PAUSE,    /* The player is in the pause state */
  RKADK_PLAYER_STATE_ERR,      /* The player is in the err state */
  RKADK_PLAYER_STATE_BUTT
} RKADK_PLAYER_STATE_E;

Related data types and interfaces

RKADK_PLAYER_GetPlayStatus

7.3.9 RKADK_PLAYER_SNAPSHOT_S

Description

Define the screenshot data structure.

Definition

typedef struct {
  RKADK_U32 u32Width;
  RKADK_U32 u32Height;
  RKADK_U32 u32DataLen;
  RKADK_U8 *pu8DataBuf;
} RKADK_PLAYER_SNAPSHOT_S;

Members

Related data types and interfaces

RKADK_PPLAYER_SNAPSHOT_RECV_FN

7.3.10 RKADK_PPLAYER_SNAPSHOT_RECV_FN

Description

Defines the screenshot data callback function pointer.

Definition

typedef void (*RKADK_PPLAYER_SNAPSHOT_RECV_FN)(RKADK_PLAYER_SNAPSHOT_S *pstData);

Members

Related data types and interfaces

RKADK_PLAYER_SNAPSHOT_S RKADK_PLAYER_SNAPSHOT_CFG_S

7.3.11 RKADK_PLAYER_SNAPSHOT_CFG_S

Description

Define the screenshot attribute structure.

Definition

typedef struct {
  RKADK_U32 u32VencChn;
  RKADK_U32 u32MaxWidth;    //Support snapshot max width, default 4096
  RKADK_U32 u32MaxHeight;   //Support snapshot max height, default 4096
  RKADK_PPLAYER_SNAPSHOT_RECV_FN pfnDataCallback;
} RKADK_PLAYER_SNAPSHOT_CFG_S;

Members

Related data types and interfaces

RKADK_PPLAYER_SNAPSHOT_RECV_FN RKADK_PLAYER_CFG_S

7.3.12 RKADK_PLAYER_VDEC_CFG_S

Description

Define the VDEC attribute structure.

Definition

typedef struct {
  RKADK_U32 u32FrameBufCnt; //frame buffer cnt(output), default: 3
  RKADK_U32 u32StreamBufCnt; //stream buffer cnt(input), default: 3
} RKADK_PLAYER_VDEC_CFG_S;

Members

Related data types and interfaces

RKADK_PLAYER_CFG_S

7.3.13 RKADK_PLAYER_RTSP_CFG_S

Description

Define the RTSP attribute structure.

Definition

typedef struct {
  const char *transport; //udp or tcp, default: udp
  RKADK_U32 u32IoTimeout; //timeout (in microseconds) of socket I/O operations
} RKADK_PLAYER_RTSP_CFG_S;

Members

Related data types and interfaces

RKADK_PLAYER_CFG_S

7.3.14 RKADK_PLAYER_PACKET

Description

Define the data packet structure and enable the use of the third-party demuxer library.

Definition

typedef struct {
  bool bEofFlag;
  RKADK_S8 *s8PacketData;
  RKADK_S32 s32PacketSize;
  RKADK_U32 u32Seq;
  RKADK_S64 s64Pts;

  //if bypass, must set pFreeCB;
  bool bBypass;
  RKADK_MPI_MB_FREE_CB pFreeCB;
} RKADK_PLAYER_PACKET;

Members

Related data types and interfaces

RKADK_PLAYER_SendAudioPacket RKADK_PLAYER_SendVideoPacket

7.3.15 RKADK_PLAYER_DATA_PARAM_S

Description

Define the audio and video parameter structure, it can be used when enabling the third-party demuxer library.

Definition

typedef struct {
  const RKADK_CHAR *pFilePath;
  RKADK_BOOL bIsRtsp;
  RKADK_BOOL bVideoExist;
  RKADK_BOOL bAudioExist;

  //video param
  RKADK_CODEC_TYPE_E enVCodecType;
  RKADK_U32 u32Width;
  RKADK_U32 u32Height;
  RKADK_FORMAT_E enPixFmt; //output pixel format
  RKADK_U32 u32FrameRate;

  //audio param
  RKADK_CODEC_TYPE_E enACodecType;
  RKADK_S32 u32BitWidth;
  RKADK_S32 u32SampleRate;
  RKADK_S32 u32Channel;
} RKADK_PLAYER_DATA_PARAM_S;

Members

Related data types and interfaces

RKADK_PLAYER_SetDataParam

8. Live Streaming

8.1 Overview

Provides basic services of standard RTSP live streaming; provides RTMP live streaming services. RTSP and RTMP do not support starting at the same time.

8.2 API Reference

8.2.1 RTSP

8.2.1.1 RKADK_RTSP_Init

Description

Initialize the RTSP module.

Syntax

RKADK_S32 RKADK_RTSP_Init(RKADK_U32 u32CamId, RKADK_U32 port, const char *path, RKADK_MW_PTR *ppHandle);

Parameters

Return value

Requirement

Header file: rkadk_rtsp.h

Library file: librkadk.so

Notice

Call RKADK_RTSP_Start after RKADK_RTSP_Init to start RTSP live streaming.

Example

rkadk_rtsp_test

See Also

RKADK_RTSP_DeInit

8.2.1.2 RKADK_RTSP_DeInit

Description

Deinitialize the RTSP module.

Syntax

RKADK_S32 RKADK_RTSP_DeInit(RKADK_MW_PTR pHandle);

Parameters

Return value

Requirement

Header file: rkadk_rtsp.h Library file: librkadk.so

Example

rkadk_rtsp_test

See Also

RKADK_RTSP_Init

8.2.1.3 RKADK_RTSP_Start

Description

Start RTSP live streaming.

Syntax

RKADK_S32 RKADK_RTSP_Start(RKADK_MW_PTR pHandle);

Parameters

Return value

Requirement

Header file: rkadk_rtsp.h Library file: librkadk.so

Notice

Call this interface after RKADK_RTSP_Init.

Example

rkadk_rtsp_test

See Also

RKADK_RTSP_Stop

8.2.1.4 RKADK_RTSP_Stop

Description

Stop RTSP live streaming.

Syntax

RKADK_S32 RKADK_RTSP_Stop(RKADK_MW_PTR pHandle);

Parameters

Return value

Requirement

Header file: rkadk_rtsp.h Library file: librkadk.so

Example

rkadk_rtsp_test

See Also

RKADK_RTSP_Start

8.2.1.5 RKADK_RTSP_VideoReset

Description

Reconfigure the RTSP live streaming.

Syntax

RKADK_S32 RKADK_RTSP_VideoReset(RKADK_MW_PTR pHandle);

Parameters

Return value

Requirement

Header file: rkadk_rtsp.h

Library file: librkadk.so

Notice

The RKADK_RTSP_VideoReset interface can only be used after RKADK_RTSP_Init. When switching resolution, frame rate, bit rate, encoding type, or recording type, reset the parameters of the Live module in the ini file by using the RKADK_PARAM_SetCamParam API. RV1126/RV1109 and RK3576 does not support dynamic switching of resolution and encoding type. You need to RKADK_RTSP_DeInit first, then configure the new resolution or encoding type, and finally RKADK_RTSP_Init again. If Live and other modules share the VI channel, both the resolution of Live and multiplexing modules need to be switched simultaneously to avoid VI and VENC resolution mismatch.

8.2.2 RTMP

8.2.2.1 RKADK_RTMP_Init

Description

Initialize RTMP module.

Syntax

RKADK_S32 RKADK_RTMP_Init(RKADK_U32 u32CamId, const char *path, RKADK_MW_PTR *ppHandle);

Parameters

Return value

Requirement

Header file: rkadk_rtmp.h Library file: librkadk.so

Example

rkadk_rtmp_test

See Also

RKADK_RTMP_DeInit

8.2.2.2 RKADK_RTMP_DeInit

Description

Deinitialize the RTMP module.

Syntax

RKADK_S32 RKADK_RTMP_DeInit(RKADK_MW_PTR pHandle);

Parameters

Return value

Requirement

Header file: rkadk_rtmp.h Library file: librkadk.so

Example

rkadk_rtmp_test

See Also

RKADK_RTMP_Init

8.2.2.3 RKADK_RTSP_VideoReset

Description

Reconfigure the RTSP live streaming.

Syntax

RKADK_S32 RKADK_RTSP_VideoReset(RKADK_MW_PTR pHandle);

Parameters

Return value

Requirement

Header file: rkadk_rtsp.h Library file: librkadk.so

Notice

The RKADK_RTMP_VideoReset interface can only be used after RKADK_RTMP_Init. When switching resolution, frame rate, bit rate, encoding type, or recording type, reset the parameters of the Live module in the ini file by using the RKADK_PARAM_SetCamParam API. RV1126/RV1109 and RK3576 does not support dynamic switching of resolution and encoding type. You need to RKADK_RTMP_DeInit first, then configure the new resolution or encoding type, and finally RKADK_RTMP_Init again. If Live and other modules share the VI channel, both the resolution of Live and multiplexing modules need to be switched simultaneously to avoid VI and VENC resolution mismatch.

9. Storage

9.1 Overview

Provides basic storage functions, currently including the following functions: File detection, storage, acquisition, management Device capacity and status query Automatically delete files Format

9.2 API Reference

9.2.1 RKADK_STORAGE_Init

Description

Storage module initialization.

Syntax

RKADK_S32 RKADK_STORAGE_Init(RKADK_MW_PTR *ppHandle, RKADK_STR_DEV_ATTR *pstDevAttr);

Parameters

Return value

Requirement

Header file: rkadk_storage.h Library file: librkadk.so

Notice

Repeated initialization is not supported. If RKADK_STR_DEV_ATTR pass in NULL, default attributes are used. The default attributes are: 2 folders, named video_front and video_back, sorted by file name, automatic deletion threshold 500~1000M, limit the number of files not used, with the ratio of 50%.

Example

rkadk_storage_test

See Also

RKADK_STORAGE_Deinit

9.2.2 RKADK_STORAGE_Deinit

Description

Storage module deinitialization.

Syntax

RKADK_S32 RKADK_STORAGE_Deinit(RKADK_MW_PTR pHandle);

Parameters

Return value

Requirement

Header file: rkadk_storage.h Library file: librkadk.so

Notice

Repeated deinitialization is not supported.

Example

rkadk_storage_test

See Also

RKADK_STORAGE_Init

9.2.3 RKADK_STORAGE_GetDevAttr

Description

Get the mounted device attribute.

Syntax

RKADK_STR_DEV_ATTR RKADK_STORAGE_GetDevAttr(RKADK_MW_PTR pHandle);

Parameters

Return value

Requirement

Header file: rkadk_storage.h Library file: librkadk.so

Notice

The RKADK_STORAGE_GetDevAttr interface can only be used after the storage module is initialized.

Example

None

See Also

None

9.2.4 RKADK_STORAGE_GetMountStatus

Description

Get device mounting status.

Syntax

RKADK_MOUNT_STATUS RKADK_STORAGE_GetMountStatus(RKADK_MW_PTR pHandle);

Parameters

Return value

Requirement

Header file: rkadk_storage.h

Library file: librkadk.so

Example

rkadk_storage_test

See Also

None

9.2.5 RKADK_STORAGE_GetCapacity

Description

Get the device capacity.

Syntax

RKADK_S32 RKADK_STORAGE_GetCapacity(RKADK_MW_PTR *ppHandle, RKADK_S32 *totalSize, RKADK_S32 *freeSize);

Parameters

Return value

Requirement

Header file: rkadk_storage.h Library file: librkadk.so

Example

rkadk_storage_test

See Also

None

9.2.6 RKADK_STORAGE_GetFileList

Description

Get a list of files.

Syntax

RKADK_S32 RKADK_STORAGE_GetFileList(RKADK_FILE_LIST *list, RKADK_MW_PTR pHandle, RKADK_SORT_TYPE sort);

Parameters