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

1. SDK描述

EasyPusher RTSP推流SDK是一款推送流媒体音/视频流给标准RTSP流媒体服务器(如EasyDarwin、Wowza)的流媒体推送库,全平台支持(包括Windows/Linux(32 & 64),ARM各平台,Android、iOS),通过EasyPusher我们就可以避免接触到稍显复杂的RTSP/RTP/RTCP推送流程,只需要调用EasyPusher的几个API接口,就能轻松、稳定地把流媒体音视频数据推送给RTSP流媒体服务器进行处理和转发,EasyPusher经过长时间的企业用户体验,稳定性非常高;

2. API接口函数定义

2.1 数据、事件回调函数

函数:
typedef int (EasyPusher_Callback)(int _id, EASY_PUSH_STATE_T _state, EASY_AV_Frame _frame, void *_userptr);

参数:
_id: EasyPusher_SetEventCallback接口设置的id,用于区分每路视频流。也可用_userptr参数来区分和信息传递。
_state: 推流状态信息
_frame: 视频帧数据
_userPtr: 用户自定义数据

2.2 SDK激活

函数:
Easy_API Easy_I32 Easy_APICALL EasyPusher_Activate(char *license);

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

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

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

函数:
Easy_API Easy_Pusher_Handle Easy_APICALL EasyPusher_Create();

返回:
本次RTSP Session的句柄

2.4 设置回调函数

函数:
Easy_API Easy_U32 Easy_APICALL EasyPusher_SetEventCallback(Easy_Pusher_Handle handle, EasyPusher_Callback callback, int id, void *userptr);

参数:
handle: EasyPusher_Create接口返回的句柄
id: 流id,用于区分每路视频流。也可用_userptr参数来区分和信息传递。
userptr: 设置用户自定义数据,每个Session对应一个userutr

2.5 开始RTSP推流

函数:
Easy_API Easy_U32 Easy_APICALL EasyPusher_StartStream(Easy_Pusher_Handle handle, char serverAddr, Easy_U16 port, char streamName, int rtpOverTcp, char username, char password, EASY_MEDIA_INFO_T* pstruStreamInfo, Easy_U32 bufferKSize, Easy_Bool createlogfile );

参数:
handle: EasyPusher_Create接口返回的句柄
serverAddr: RTSP服务器地址
port: RTSP服务器端口
streamName: 流名称,xxx.sdp
rtpOverTcp: 传输协议,1-tcp, 2-udp
username: 用户名,正常设置为空
password: 密码,正常设置为空
pstruStreamInfo:流媒体信息
bufferKSize: 缓冲队列大小,默认设置1024
createlogfile: 是否开启log,0-关闭,1-开启

2.6 推送流媒体帧数据

函数:
Easy_API Easy_U32 Easy_APICALL EasyPusher_PushFrame(Easy_Pusher_Handle handle, EASY_AV_Frame* frame );

参数:
handle: EasyPusher_Create接口返回的句柄
frame: 推送的流媒体帧数据

2.7 停止RTSP推流

函数:
Easy_API Easy_U32 Easy_APICALL EasyPusher_StopStream(Easy_Pusher_Handle handle);

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

2.8 释放推送句柄

函数:
Easy_API Easy_U32 Easy_APICALL EasyPusher_Release(Easy_Pusher_Handle handle);

参数:
handle: EasyPusher_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 __EASY_AV_Frame
{
Easy_U32 u32AVFrameFlag; /* 帧标志 视频 or 音频 */
Easy_U32 u32AVFrameLen; /* 帧的长度 */
Easy_U32 u32VFrameType; /* 视频的类型,I帧或P帧 */
Easy_U8 *pBuffer; /* 数据 */
Easy_U32 u32TimestampSec; /* 时间戳(秒)*/
Easy_U32 u32TimestampUsec; /* 时间戳(微秒) */
}EASY_AV_Frame;
/* 推送事件类型定义 */
typedef enum __EASY_PUSH_STATE_T
{
EASY_PUSH_STATE_CONNECTING = 1, /* 连接中 */
EASY_PUSH_STATE_CONNECTED, /* 连接成功 */
EASY_PUSH_STATE_CONNECT_FAILED, /* 连接失败 */
EASY_PUSH_STATE_CONNECT_ABORT, /* 连接异常中断 */
EASY_PUSH_STATE_PUSHING, /* 推流中 */
EASY_PUSH_STATE_DISCONNECTED, /* 断开连接 */
EASY_PUSH_STATE_ERROR
}EASY_PUSH_STATE_T;