接口协议适用平台:(Windows&Linux&ARM)

1. SDK描述

EasyRTMPClient拉流功能组件是紫鲸团队开发和维护的一套非常稳定、易用、支持重连的RTMPClient工具,以SDK的形式提供,全平台支持(包括Windows/Linux 32&64,ARM各平台),接口简单、兼容性强、且成熟稳定!能清晰地回调出帧率、时间戳、首帧是否为I帧、ES数据流、能保存ES进行分析,一直都是围绕着“Easy”来进行架构和设计,能最接近现实项目中的应用需求!

2. API接口函数定义

2.1 数据、事件回调函数

函数:
typedef int (EasyRTMPClientCallBack)(int _channelId, void _channelPtr, int _frameType, char pBuf, EASY_FRAME_INFO _frameInfo);

参数:
_channelId: 通道号, 由EasyRTMPClient_StartStream设置
_channelPtr: 用户自定义数据,由EasyRTMPClient_StartStream设置
_frameType: EASY_SDK_VIDEO_FRAME_FLAG/EASY_SDK_AUDIO_FRAME_FLAG/EASY_SDK_EVENT_FRAME_FLAG/…
_pBuf: 回调的数据部分
_frameInfo: 帧结构参数

2.2 SDK激活

函数:
Easy_API Easy_I32 EasyRTMPClient_Activate(char *license);

参数:
license: SDK激活码,可在 www.pvale.com 在线获取,或联系我们。

返回:
返回值为第三节的EASY_ACTIVATE_ERR_CODE_ENUM枚举类型

2.3 创建EasyRTMPClient句柄 返回为句柄值

函数:
Easy_API Easy_RTMP_Handle EasyRTMPClient_Create();

返回:
返回Easy_RTMP_Handle 0表示失败

2.4 设置数据回调

函数:
Easy_API int EasyRTMPClient_SetCallback(Easy_RTMP_Handle handle, EasyRTMPClientCallBack _callback);

参数:
handle: EasyRTMPClient_Create接口返回的句柄
callback: 设置数据、事件回调函数

2.5 打开一路RTMP网络流

函数:
Easy_API int EasyRTMPClient_StartStream(Easy_RTMP_Handle _handle, int _channelid, const char _url, void _channelPtr);

参数:
_handle: EasyRTMPClient_Create接口返回的句柄
_channelid: 自定义通道号,回调函数返回时会携带回来,可用于表示通道,也可用_channelPtr参数来表示和参数传递
url: 拉取的流地址
_channelPtr: 用户自定义数据,回调函数返回时会带对应的userPtr,可用于标记对应流的回调和参数传递

2.6 释放EasyRTMPClient 参数为EasyRTMP句柄

函数:
Easy_API int EasyRTMPClient_Release(Easy_RTMP_Handle handle);

参数:
handle: EasyRTMPClient_Create接口返回的句柄

3. 结构体描述

typedef enum __EASY_ACTIVATE_ERR_CODE_ENUM
{
EASY_ACTIVATE_INVALID_KEY = -1, /* 无效Key */
EASY_ACTIVATE_TIME_ERR = -2, /* 时间错误 */
EASY_ACTIVATE_PROCESS_NAME_LEN_ERR = -3, /* 进程名称长度不匹配 */
EASY_ACTIVATE_PROCESS_NAME_ERR = -4, /* 进程名称不匹配 */
EASY_ACTIVATE_VALIDITY_PERIOD_ERR= -5, /* 有效期校验不一致 */
EASY_ACTIVATE_PLATFORM_ERR = -6, /* 平台不匹配 */
EASY_ACTIVATE_COMPANY_ID_LEN_ERR= -7, /* 授权使用商不匹配 */
EASY_ACTIVATE_SUCCESS = 0, /* 激活成功 */
}EASY_ACTIVATE_ERR_CODE_ENUM;
/* 视频编码 */
#define EASY_SDK_VIDEO_CODEC_H264 0x1C /* H.264 */
#define EASY_SDK_VIDEO_CODEC_H265 0x48323635 /* H.265 */
#define EASY_SDK_VIDEO_CODEC_MJPEG 0x08 /* MJPEG */
#define EASY_SDK_VIDEO_CODEC_MPEG4 0x0D /* MPEG4 */
/* 音频编码 */
#define EASY_SDK_AUDIO_CODEC_AAC 0x15002 /* AAC */
#define EASY_SDK_AUDIO_CODEC_G711U 0x10006 /* G711 ulaw*/
#define EASY_SDK_AUDIO_CODEC_G711A 0x10007 /* G711 alaw*/
#define EASY_SDK_AUDIO_CODEC_G726 0x1100B /* G726 */
#define EASY_SDK_EVENT_CODEC_ERROR 0x63657272 /* ERROR */
#define EASY_SDK_EVENT_CODEC_EXIT 0x65786974 /* EXIT */
/* 音视频帧标识 */
#define EASY_SDK_VIDEO_FRAME_FLAG 0x00000001 /* 视频帧标志 */
#define EASY_SDK_AUDIO_FRAME_FLAG 0x00000002 /* 音频帧标志 */
#define EASY_SDK_EVENT_FRAME_FLAG 0x00000004 /* 事件帧标志 */
#define EASY_SDK_RTP_FRAME_FLAG 0x00000008 /* RTP帧标志 */
#define EASY_SDK_SDP_FRAME_FLAG 0x00000010 /* SDP帧标志 */
#define EASY_SDK_MEDIA_INFO_FLAG 0x00000020 /* 媒体类型标志*/
/* 视频关键字标识 */
#define EASY_SDK_VIDEO_FRAME_I 0x01 /* I帧 */
#define EASY_SDK_VIDEO_FRAME_P 0x02 /* P帧 */
#define EASY_SDK_VIDEO_FRAME_B 0x03 /* B帧 */
#define EASY_SDK_VIDEO_FRAME_J 0x04 /* JPEG */
/* 连接类型 */
typedef enum __EASY_RTP_CONNECT_TYPE
{
EASY_RTP_OVER_TCP = 0x01, /* RTP Over TCP */
EASY_RTP_OVER_UDP /* RTP Over UDP */
}EASY_RTP_CONNECT_TYPE;
/* 媒体信息 */
typedef struct __EASY_MEDIA_INFO_T
{
Easy_U32 u32VideoCodec; /* 视频编码类型 */
Easy_U32 u32VideoFps; /* 视频帧率 */
Easy_U32 u32VideoQueueSize; /* 视频缓存大小 */
Easy_U32 u32AudioCodec; /* 音频编码类型 */
Easy_U32 u32AudioSamplerate; /* 音频采样率 */
Easy_U32 u32AudioChannel; /* 音频通道数 */
Easy_U32 u32AudioBitsPerSample; /* 音频采样精度 */
Easy_U32 u32AudioQueueSize; /* 音频缓存大小 */
Easy_U32 u32VpsLength; /* H.265格式VPS长度 */
Easy_U32 u32SpsLength; /* SPS数据长度 */
Easy_U32 u32PpsLength; /* PPS数据长度 */
Easy_U32 u32SeiLength; /* SEI信息数据长度 */
Easy_U8 u8Vps[255]; /* VPS数据内容 */
Easy_U8 u8Sps[255]; /* SPS数据内容 */
Easy_U8 u8Pps[128]; /* PPS数据内容 */
Easy_U8 u8Sei[128]; /* SEI数据内容 */
}EASY_MEDIA_INFO_T;
struct EASY_AV_Frame
{
Easy_U32 u32AVFrameFlag; /* 帧标志 视频 or 音频 */
Easy_U32 u32AVFrameLen; /* 帧的长度 */
Easy_U32 u32VFrameType; /* 视频的类型,I帧或P帧 */
Easy_U8 *pBuffer; /* 数据 */
Easy_U32 u32TimestampSec; /* 时间戳(秒)*/
Easy_U32 u32TimestampUsec; /* 时间戳(微秒) */
};
enum MediaType
{
e_MediaType_None = 0,
e_MediaType_raw,
e_MediaType_Avc,//h264 video
e_MediaType_Aac,//aac audio
e_MediaType_script,
e_MediaType_Pcm,
e_MediaType_Flv //flv tag
};
其他错误:
const int NOT_INIT = -101;//未初始化,调用EasyRTMP_Create EasyRTMP_StartStream 先
const int URL_EMPTY = -102;//URL为空
const int URL_SETUP_FAILED = -103;//RTMP Setup失败
const int RTMP_CONNECT_FAILED = -104;
const int RTMPSTREAM_CONNECT_FAILED = -105;
const int RECONNECT_SETUP_FAILED = -106;
const int RECONNECT_FAILED = -107;
const int RTMP_UNCONNECTED = -108;
const int RTMP_RECONNECTED_FAILED = -109;
const int RTMP_RECV_PARAMERROR = -110;
const int RTMP_RECONNECT_TIMEOUT = -111;
const int FRAME_TOO_LEN = -112;
const int FRAME_ERROR = -113;//帧错误
const int SEND_SEQUNECE_FAILED = -114;
const int READ_BUFFER_FAILED = -115;
const int READ_DATA_PARAM_ERROR = -116;
const int RTMP_INSIDE_ERROR = -117;
const int RTMP_PARSE_FAILED = -118;/*RTMP帧解析失败*/