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

1. SDK描述

EasyRTMP是一套调用简单、功能完善、运行高效稳定的RTMP功能组件，经过多年实战和线上运行打造，支持RTMP推送断线重连、环形缓冲、智能丢帧、网络事件回调，支持Windows、Linux、arm（hisiv100/hisiv200/hisiv300/hisiv400/etc..）、Android、iOS平台，支持市面上绝大部分的RTMP流媒体服务器，包括Wowza、Red5、ngnix_rtmp、crtmpserver等主流RTMP服务器，能够完美应用于各种行业的直播需求，手机直播、桌面直播、摄像机直播、课堂直播等等方面！

2. API接口函数定义

2.1 数据、事件回调函数

函数：
typedef int (EasyRTMPCallBack)(int _frameType, char _pBuf, EASY_RTMP_STATE_T _state, void _userPtr);

参数：
_frameType: EASY_SDK_VIDEO_FRAME_FLAG/EASY_SDK_AUDIO_FRAME_FLAG/EASY_SDK_EVENT_FRAME_FLAG/…
_pBuf: 回调的数据部分，具体用法看Demo
_state: 连接状态：连接断开、重新连接、已连接
_userPtr: 用户自定义数据

2.2 SDK激活

函数：
EasyRTMP_API Easy_I32 Easy_APICALL EasyRTMP_Activate(char *license);

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

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

2.3 创建RTMP推送Session 返回推送句柄

函数：
EasyRTMP_API Easy_RTMP_Handle Easy_APICALL EasyRTMP_Create(void);

返回：
本次RTMP Session的句柄

2.4 设置数据回调

函数：
EasyRTMP_API Easy_I32 Easy_APICALL EasyRTMP_SetCallback(Easy_RTMP_Handle handle, EasyRTMPCallBack callback, void * userptr);

参数：
handle： EasyRTMP_Create接口返回的句柄
callback：设置数据、事件回调函数
userptr：设置用户自定义数据，每个Session对应一个userutr

2.5 连接RTMP服务器

函数：
EasyRTMP_API Easy_Bool Easy_APICALL EasyRTMP_Connect(Easy_RTMP_Handle handle, const char *url);

参数：
handle： EasyRTMP_Create接口返回的句柄
url： RTMP推流地址

2.6 设置RTMP推送的参数信息

函数：
EasyRTMP_API Easy_I32 Easy_APICALL EasyRTMP_InitMetadata(Easy_RTMP_Handle handle, EASY_MEDIA_INFO_T* pstruStreamInfo, Easy_U32 bufferKSize);

参数：
handle： EasyRTMP_Create接口返回的句柄
pstruStreamInfo：参数信息
bufferKSize： SDK中缓存队列大小，默认1024

2.7 推送H264或AAC流

函数：
EasyRTMP_API Easy_U32 Easy_APICALL EasyRTMP_SendPacket(Easy_RTMP_Handle handle, EASY_AV_Frame* frame);

参数：
handle： EasyRTMP_Create接口返回的句柄
frame：帧数据

2.8 停止RTMP推送，释放句柄

函数：
EasyRTMP_API void Easy_APICALL EasyRTMP_Release(Easy_RTMP_Handle handle);

参数：
handle： EasyRTMP_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;
/* 帧信息 */
typedef struct 
{
	unsigned int	codec;				/* 音视频格式 */
	unsigned int	type;				/* 视频帧类型 */
	unsigned char	fps;				/* 视频帧率 */
	unsigned short	width;				/* 视频宽 */
	unsigned short  height;				/* 视频高 */
	unsigned int	reserved1;			/* 保留参数1 */
	unsigned int	reserved2;			/* 保留参数2 */
	unsigned int	sample_rate;		/* 音频采样率 */
	unsigned int	channels;			/* 音频声道数 */
	unsigned int	bits_per_sample;	/* 音频采样精度 */
	unsigned int	length;				/* 音视频帧大小 */
	unsigned int    timestamp_usec;		/* 时间戳,微妙 */
	unsigned int	timestamp_sec;		/* 时间戳 秒 */
	
	float			bitrate;			/* 比特率 */
	float			losspacket;			/* 丢包率 */
}RTSP_FRAME_INFO;
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 EASY_RTMP_STATE_T
{
    EASY_RTMP_STATE_CONNECTING   =   1,     /* 连接中 */
    EASY_RTMP_STATE_CONNECTED,              /* 连接成功 */
    EASY_RTMP_STATE_CONNECT_FAILED,         /* 连接失败 */
    EASY_RTMP_STATE_CONNECT_ABORT,          /* 连接异常中断 */
    EASY_RTMP_STATE_PUSHING,                /* 推流中 */
    EASY_RTMP_STATE_DISCONNECTED,           /* 断开连接 */
    EASY_RTMP_STATE_ERROR
};