播放本地音视频文件

• startPlayAudioFile
• stopPlayAudioFile
• pauseAudioFile
• resumeAudioFile
• setAudioFileVolume
• startPlayMediaFile
• stopPlayMediaFile
• pausePlayMedia
• resumePlayMedia
• seekPlayMedia
• setPlayMediaVolume
• 备注

最近更新时间：2022-01-25 15:55:20 星期二

startPlayAudioFile

简要描述
- 播放本地音频文件

返回一个 播放ID

接口名称
- - (int)startPlayAudioFile:(NSString *)filePath loop:(BOOL)loop progress:(progress_block _Nullable)progress;

参数

参数名	必填	类型	说明
filePath	是	NSString	文件路径
loop	是	BOOL	是否循环播放
progress	否	progress_block	播放进度的回调

方法示例

    NSString *path = [[NSBundle mainBundle] pathForResource:@"XXX" ofType:@"mp3"];
    int audioId = [_roomMgr startPlayAudioFile:path
                                          loop:NO
                                      progress:^(int playID, int64_t current, int64_t total) {
                            NSLog(@"playID = %d, 当前进度：%d, 总时长：%d", playID, current, total);
                       }];
    if (audioId == -1) {
        NSLog(@"播放失败！");
    }

返回值说明

类型	说明
int	返回播放音频标识， 播放ID, 若返回-1:表示播放失败.

stopPlayAudioFile

简要描述
- 停止播放本地音频

接口名称
- - (int)stopPlayAudioFile:(int)audioId;

参数

参数名	必填	类型	说明
audioId	是	int	startPlayAudioFile播放成功时返回的播放ID； 若此为-1时，表示停止所有正在播放的音频

方法示例

    [_roomMgr stopPlayAudioFile:1];

返回值说明

类型	说明
int	0:表示调用成功，非0:表示调用失败

pauseAudioFile

简要描述
- 暂停播放音频

接口名称
- - (int)pauseAudioFile:(int)audioId;

参数

参数名	必填	类型	说明
audioId	是	int	播放ID

方法示例

    [_roomMgr pauseAudioFile:1];

返回值说明

类型	说明
int	0:表示调用成功，非0:表示调用失败

resumeAudioFile

简要描述
- 恢复播放音频

接口名称
- - (int)resumeAudioFile:(int)audioId;

参数

参数名	必填	类型	说明
audioId	是	int	播放ID

方法示例

    [_roomMgr resumeAudioFile:1];

返回值说明

类型	说明
int	0:表示调用成功，非0:表示调用失败

setAudioFileVolume

简要描述
- 设置播放音频的音量

接口名称
- - (BOOL)setAudioFileVolume:(CGFloat)volume soundId:(int)audioId;

参数

参数名	必填	类型	说明
volume	是	CGFloat	音量大小，取值范围:0.0~1.0 默认1.0
audioId	否	int	播放ID

方法示例

    [_roomMgr setAudioFileVolume:0.9 soundId:1];

返回值说明

类型	说明
int	0:表示调用成功，非0:表示调用失败

startPlayMediaFile

简要描述
- 播放本地媒体文件

可以播放本地音频或者视频文件。 返回一个 播放ID

接口名称
- - (int)startPlayMediaFile:(NSString *)filePath window:(UIView * _Nullable)window loop:(BOOL)loop progress:(progress_block _Nullable)progress;

参数

参数名	必填	类型	说明
filePath	是	NSString	文件路径
window	否	UIView	视频渲染窗口。若只是音频，可以 nil。
loop	是	BOOL	是否循环播放
progress	否	progress_block	播放进度回调

方法示例

    NSString *path = [[NSBundle mainBundle] pathForResource:@"XXX" ofType:@"mp4"];
    UIView *view = [[UIView alloc] initWithFrame:CGRectMake(0, 0, 100, 100)];
    view.backgroundColor = [UIColor blackColor];
    [self.view addSubview:view];
    [self.view bringSubviewToFront:view];
    int playID = [_roomMgr startPlayAudioFile:path
                                       window:view
                                         loop:NO
                                     progress:^(int playID, int64_t current, int64_t total) {
                            NSLog(@"playID = %d, 当前进度：%d, 总时长：%d", playID, current, total);
                       }];
    if (playID == -1) {
        NSLog(@"播放失败！");
    }

返回值说明

类型	说明
int	返回播放标识， 播放ID, 若返回-1:表示播放失败.

stopPlayMediaFile

简要描述
- 停止播放本地媒体文件

接口名称
- - (int)stopPlayMediaFile:(int)playID;

参数

参数名	必填	类型	说明
playID	是	int	播放ID

方法示例

    [_roomMgr stopPlayMediaFile:2];

返回值说明

类型	说明
int	0:表示调用成功，非0:表示调用失败

pausePlayMedia

简要描述
- 暂停播放媒体

接口名称
- - (int)pausePlayMedia:(int)playID;

参数

参数名	必填	类型	说明
playID	是	int	播放ID

方法示例

    [_roomMgr pausePlayMedia:2];

返回值说明

类型	说明
int	0:表示调用成功，非0:表示调用失败

resumePlayMedia

简要描述
- 恢复播放媒体

接口名称
- - (int)resumePlayMedia:(int)playID;

参数

参数名	必填	类型	说明
playID	是	int	播放ID

方法示例

    [_roomMgr resumePlayMedia:2];

返回值说明

seekPlayMedia

简要描述
- seek播放的媒体

接口名称
- - (int)seekPlayMedia:(int)playID pos:(double)pos;

参数

参数名	必填	类型	说明
playID	是	int	播放ID
pos	是	double	seek播放进度位置

方法示例

    [_roomMgr seekPlayMedia:2 pos:0.4];

返回值说明

类型	说明
int	0:表示调用成功，非0:表示调用失败

setPlayMediaVolume

简要描述
- 设置播放媒体的音量

接口名称
- - (int)setPlayMedia:(int)playID volume:(CGFloat)volume;

参数

参数名	必填	类型	说明
playID	是	int	播放ID
volume	是	CGFloat	音量大小，0.0 - 1.0，默认1.0

方法示例

    [_roomMgr setPlayMedia:2 volume:0.9];

返回值说明

类型	说明
int	0:表示调用成功，非0:表示调用失败

备注

• 更多返回错误代码请看 TKRoomErrorCode 错误代码描述