直播云

  • 直播云 > SDK 下载 > 播放端 >QPlayer2 Harmony 端 > 基于 Core 的 QPlayer2 接入指南 > 基础能力使用

    基础能力使用

    最近更新时间: 2024-06-11 17:47:02

    基础能力使用

    快速开始 中,我们完成了qplayer2播放器的创建\播放\销毁,本文介绍如何使用qplayer2的播放能力

    播放

    创建播放数据

    let builder : QMediaModelBuilder = new QMediaModelBuilder()
    builder.addStreamElement(element.mUserType,element.mUrlType,element.mQuality.valueOf(),element.mUrl,element.mIsSelected,element.mReferer,element.mBackupUrl)
    let model : QMediaModel = builder.build(is_live)
    

    addStreamElements 属性说明

    属性名 属性说明
    userType 用户自定义Type,目前预留,可以填空字符串
    url 资源地址
    urlType 媒体的资源属性 只包含视频/只包含音频/同时有视频音频
    quality 清晰度
    isSelected 是否起播时播放该流
    backupUrl 备用地址
    referer http/https 协议的地址 支持该属性

    播放媒体资源

    /*** 播放音视频资源
     * @param model 音视频资源
     */ 
    this.mPlayerContext.get_control_handler().playMediaModel(model)
    

    播放错误监听

    当视频起播时,如果遇到网络等问题原因,导致没有和服务器建立链接,那么会导致视频播放失败,总共会有3次重试机会,3次都失败的情况下会回调onOpenFailed方法。
    当视频已经起播后,在中途遇到网络等问题原因,进入buffer, 那么内核会一直重试,直到再次连接上服务端继续播放,或者用户通过接口停止播放该视频,在重试的过程中 onReconnectStart / onReconnectEnd 会被回调,那么可以监控回调的次数来做业务层的结束播放的策略,当然在正常播放的情况下,这两个方法也是会被回调的,所以最好结合buffer的回调数据一起使用。

    private mMediaNetworkListener : QIPlayerMediaNetworkListener = {
    /***
     开始重连
     @param context 当前的播放器
     @param userType 重连url流的userType
     @param urlType 重连url流的urlType
     @param url 重连的url
     @param retryTime 已重试的次数
    */
        onReconnectStart:(context : QIPlayerContext , userType: string , urlType: QPlayerUrlType , url: string , retryTime: number ) => {
          
        },
    /***
     重连结束
     @param context 当前的播放器
     @param userType 重连url流的userType
     @param urlType 重连url流的urlType
     @param url 重连的url
     @param retryTime 已重试的次数
     @param error 错误码
    */
        onReconnectEnd:(context : QIPlayerContext , userType: string , urlType: QPlayerUrlType , url: string , retryTime: number , error: QPlayerOpenError ) => {
          
        },
    /***
     打开失败
     @param context 当前的播放器
     @param userType 重连url流的userType
     @param urlType 重连url流的urlType
     @param url 重连的url
     @param error 错误码
    */
        onOpenFailed:(context : QIPlayerContext , userType: string , urlType: QPlayerUrlType , url: string , error: QPlayerOpenError ) => {
          
        }
      }
    
    
    //添加监听
    this.mPlayerContext.get_control_handler().addPlayerMediaNetworkListener(this.mMediaNetworkListener)
    //移除监听
    this.mPlayerContext.get_control_handler().removePlayerMediaNetworkListener(this.mMediaNetworkListener)
    //移除全部监听
    this.mPlayerContext.get_control_handler().removeAllPlayerMediaNetworkListener()
    

    播放错误码枚举

    export enum QPlayerOpenError{
      UNKNOW = 10000,
      NONE = 0,
      IOERROR = -5,
      INTERRUPT = -1414092869,
      URL_INVALID = -875574520,
      FORMAT_INVALID = -1094995529
    }
    

    暂停播放

    this.mPlayerContext.get_control_handler().pauseRender()
    

    恢复播放

    this.mPlayerContext.get_control_handler().resumeRender()
    

    停止当前视频播放

    this.mPlayerContext.get_control_handler().stop()
    

    鉴权

    鉴权功能介绍见 鉴权相关文档

    鉴权监听

    private mAuthenticationListener : QIPlayerAuthenticationListener = {
    /**
     @brief 鉴权失败回调
     @param context 当前播放器
     @param error 失败错误码
     */
        onAuthenticationFailed:(context: QIPlayerContext, error:QPlayerAuthenticationErrorType)=>{
          this.addToastView(`鉴权失败:${error.valueOf()}`)
        },
    
    /**
     @brief 鉴权成功回调
     @param context 当前播放器
     */
        onAuthenticationSuccess:(context: QIPlayerContext)=>{
          this.addToastView("鉴权成功")
        }
      }
    
    //添加监听
    this.mPlayerContext.get_control_handler().addPlayerAuthenticationListener(this.mAuthenticationListener)
    //移除监听
    this.mPlayerContext.get_control_handler().removePlayerAuthenticationListener(this.mAuthenticationListener)
    //移除全部监听
    this.mPlayerContext.get_control_handler().removeAllPlayerAuthenticationListener()
    

    鉴权错误码枚举

    /**
     鉴权不通过错误码
     */
    export enum QPlayerAuthenticationErrorType {
      NONE,             //鉴权出错
      NO_BASE_AUTH,     //缺少基础功能权限
      NO_VR_AUTH,       //缺少VR功能权限
      NO_BLIND_AUTH,    //缺少色盲功能权限
      NO_SEI_AUTH,      //缺少SEI功能权限
      NO_SRT_AUTH,      //缺少SRT功能权限
      NO_APM_AUTH       //缺少APM功能权限
    };
    

    切换视频进度

    参数为要定位的position 单位毫秒

    this.mPlayerContext.get_control_handler().seek(1000)
    

    设置起播方式

    下一次播放生效

    this.mPlayerContext.get_control_handler().setSeekMode(QPlayerSeek.NORMAL)
    

    seek方式枚举

    export enum QPlayerSeek {
      NORMAL = 0,   //关键帧
      ACCURATE = 1, //精准
    }
    

    seek 状态监听

    一般情况下 seek都会成功,如果网络差的情况下,会无限loading(除非调用stop才会停止),直到seek到指定的位置为止。但是如果视频源本身是格式不正确的,比如pts错乱等问题,才会导致seek失败,所以在seek失败回调中,做好提示工作就好,不要尝试再次seek

    private mSeekListener : QIPlayerSeekListener = {
    /**
     seek成功回调
     @param context 当前的播放器
    */
        onSeekSuccess:(context : QIPlayerContext) => {
        },
    
    /**
     seek失败回调
     @param context 当前的播放器
    */
        onSeekFailed:(context : QIPlayerContext) => {
        }
      }
    
    
    //添加监听
    this.mPlayerContext.get_control_handler().addPlayerSeekListener(this.mSeekListener)
    //移除监听
    this.mPlayerContext.get_control_handler().removePlayerSeekListener(this.mSeekListener)
    //移除全部监听
    this.mPlayerContext.get_control_handler().removeAllPlayerSeekListener()
    

    获取当前播放状态

    this.mPlayerContext.get_control_handler().currentPlayerState
    

    获取视频时长

    this.mPlayerContext.get_control_handler().duration
    

    获取当前进度

    this.mPlayerContext.get_control_handler().currentPosition
    

    获取当前下载速度

    this.mPlayerContext.get_control_handler().downloadSpeed
    

    获取当前缓冲进度

    this.mPlayerContext.get_control_handler().bufferPostion
    

    播放器状态

    在整个播放器实例生命周期中,播放会在不同的状态中切换,用户可以通过监听播放器状态,实现上层业务逻辑,
    比如在视频播放完时,展示其他视频的推荐页,那么只需监听播放器状态回调,待回调的状态是COMPLETED,则展示推荐页

    播放器状态枚举

    export enum QPlayerState {
      NONE = 0, //初始状态 0
      INIT = 1, //播放器开始创建各种对象 没有对应的state 创建完对象就上报这个状态 1
      PREPARE = 2, //开始拉视频数据解码变换等,重新换地址后,都走这个状态 2
      PLAYING = 4, //播放中 4
      PAUSED_RENDER = 6, //暂停渲染 6
      COMPLETED = 7, //播放完成 7
      SEEKING = 8, //SEEK 8
      STOPPED = 9, //停止当前播放的视频 9
      MISTAKE = 10, //播放出错 是否需要分 可恢复 和 不可恢复 10
      END = 11, //播放器释放各种对象完成 11
      MEDIA_ITEM_PREPARE = 12, //开始拉视频数据解码变换等,重新换地址后,都走这个状态 针对Media Item的play 方式 12
      RELEASE = 13 //播放器结束,且释放各类资源 13
    }
    

    播放器状态变更监听相关

    private mStateChangeListener : QIPlayerStateChangeListener ={
    /**
     状态变更回调
     @param context 当前的播放器 
     @param state 播放器状态
     */
          onStateChange:(context : QIPlayerContext ,state: QPlayerState)=>{
          }
       }
    
    //添加监听
    this.mPlayerContext.get_control_handler().addPlayerStateListener(this.mStateChangeListener)
    //移除监听
    this.mPlayerContext.get_control_handler().removePlayerStateListener(this.mStateChangeListener)
    //移除全部监听
    this.mPlayerContext.get_control_handler().removeAllPlayerStateListener()
    

    播放进度监听

    只有在点播的时候 duration 和 progress 才有意义,直播的话这两个值没有参考意义

    private mProgressListener : QIPlayerProgressListener = {
    /***
     进度变更回调
     @param context 当前的播放器
     @param progress 当前进度 单位毫秒
     @param duration 当前视频总时长 单位毫秒
    */
        onProgressChanged:(context:QIPlayerContext,  progress:number, duration:number) => {
        }
      }
    
    //添加监听
    this.mPlayerContext.get_control_handler().addPlayerProgressChangeListener(this.mProgressListener)
    //移除监听
    this.mPlayerContext.get_control_handler().removePlayerProgressChangeListener(this.mProgressListener)
    //移除全部监听
    this.mPlayerContext.get_control_handler().removeAllPlayerProgressChangeListener()
    

    实时帧率

    获取当前fps

    this.mPlayerContext.get_control_handler().fps
    

    实时帧率监听

    private mFPSListener : QIPlayerFPSListener = {
    /**
     @brief fps 改变的回调
     @param context 当前的播放器
     @param fps 帧率
     */
          onFPSChanged:(context:QIPlayerContext, FPS:number)=>{
          }
       }
    //添加监听
    this.mPlayerContext.get_control_handler().addPlayerFPSChangeListener(this.mFPSListener)
    //移除监听
    this.mPlayerContext.get_control_handler().removePlayerFPSChangeListener(this.mFPSListener)
    //移除全部监听
    this.mPlayerContext.get_control_handler().removeAllPlayerFPSChangeListener()
    

    像素格式或者音频sample格式不支持的监听

    private mFormatListener : QIPlayerFormatListener = {
    /**
     @brief 当前有format 不支持,所以视频没法播放
     @param context 当前的播放器
     */
        onFormatNotSupport:(context:QIPlayerContext)=>{
        }
      }
    
    //添加监听
    this.mPlayerContext.get_control_handler().addPlayerFormatListener(this.mFormatListener)
    //移除监听
    this.mPlayerContext.get_control_handler().removePlayerFormatListener(this.mFormatListener)
    //移除全部监听
    this.mPlayerContext.get_control_handler().removeAllPlayerFormatListener()
    

    缓冲拉流监听

    private mDownloadListener : QIPlayerDownloadListener = {
    /**
     @brief 拉流速率改变
     @param context 当前的播放器
     @param downloadSpeed 速度 单位: b/s (比特每秒)
     @param bufferPos 缓冲的进度
     */
          onDownloadChanged:(context:QIPlayerContext, speed:number, bufferPos:number)=>{
          }
       }
    
    //添加监听
    this.mPlayerContext.get_control_handler().addPlayerDownloadChangeListener(this.mDownloadListener)
    //移除监听
    this.mPlayerContext.get_control_handler().removePlayerDownloadChangeListener(this.mDownloadListener)
    //移除全部监听
    this.mPlayerContext.get_control_handler().removeAllPlayerDownloadChangeListener()
    

    播放器操作不允许执行监听

    在某些状态下,一些操作将不被执行,通过该监听回调上来通知

    private mCommandNotAllowListener : QIPlayerCommandNotAllowListener = {
    /**
     @brief 操作不被允许回调
     @param context 操作异常的播放器
     @param commandName 操作名称
     @param state 操作被检测时播放器的状态
     */
        onCommandNotAllow:(context:QIPlayerContext, commandName:string, state:QPlayerState)=>{}
      }
    
    //添加监听
    this.mPlayerContext.get_control_handler().addPlayerCommandNotAllowListener(this.mCommandNotAllowListener)
    //移除监听
    this.mPlayerContext.get_control_handler().removePlayerCommandNotAllowListener(this.mCommandNotAllowListener)
    //移除全部监听
    this.mPlayerContext.get_control_handler().removeAllPlayerCommandNotAllowListener()
    

    buffering 监听

    private mBufferingListener : QIPlayerBufferingListener = {
    
    /**
     @brief 开始buffering
     @param context 当前播放器  
     */
        onBufferingStart:(context:QIPlayerContext)=>{
        },
    
    /**
     @brief 结束buffering
     @param context 当前播放器
     */
        onBufferingEnd:(context: QIPlayerContext)=>{}
      }
    //添加监听
    this.mPlayerContext.get_control_handler().addPlayerBufferingChangeListener(this.mBufferingListener)
    //移除监听
    this.mPlayerContext.get_control_handler().removePlayerBufferingChangeListener(this.mBufferingListener)
    //移除全部监听
    this.mPlayerContext.get_control_handler().removeAllPlayerBufferingChangeListener()
    

    码率

    获取当前码率

    this.mPlayerContext.get_control_handler().biteRate
    

    实时码率监听

    private mBiteRateListener : QIPlayerBiteRateListener = {
    /**
     @brief 码率变换回调
     @param context 当前播放器 
     @param bitrate 比特率, 单位:bps
     */
        onBiteRateChanged:(context:QIPlayerContext, bitrate:number)=>{}
      }
    //添加监听
    this.mPlayerContext.get_control_handler().addPlayerBiteRateChangeListener(this.mBiteRateListener)
    //移除监听
    this.mPlayerContext.get_control_handler().removePlayerBiteRateChangeListener(this.mBiteRateListener)
    //移除全部监听
    this.mPlayerContext.get_control_handler().removeAllPlayerBiteRateChangeListener()
    

    渲染相关监听

    private mRenderListener : QIPlayerRenderListener = {
    /**
     首帧耗时回调
     @param context 当前的播放器
     @param elapsedTime 从play 开始到首帧渲染出来的总耗时 单位毫秒
    */
          onFirstFrameRendered:(context : QIPlayerContext, elapsedTime:number) => {
          }
       }
    
    //添加监听
    this.mPlayerContext.get_render_handler().addPlayerRenderListener(this.mRenderListener)
    //移除监听
    this.mPlayerContext.get_control_handler().removePlayerRenderListener(this.mRenderListener)
    //移除全部监听
    this.mPlayerContext.get_control_handler().removeAllPlayerRenderListener()
    

    后台播放

    后台播放除了 QPlayer2 设置以外,还需要申请鸿蒙的长时任务和音频后台播放。同时还在 module.json 中需要申请后台播放权限

    设置是否支持后台播放

    /**
     *设置是否后台播放
     * @param enable yes后台播放,no后台播放暂停
     */
    this.mPlayerContext.get_control_handler().setBackgroundPlayEnable(true)
    

    鸿蒙长时任务和音频后台播放

    async createSession() {
        let type: AVSessionManager.AVSessionType = 'audio';
        let session = await AVSessionManager.createAVSession(this.context,'SESSION_NAME', type);
    
        // 激活接口要在元数据、控制命令注册完成之后再执行
        await session.activate();
        console.info(`session create done : sessionId : ${session.sessionId}`);
      }
      onBackground() {
        // Ability has back to background
        hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onBackground');
        this.createSession()
        let wantAgentInfo : wantAgent.WantAgentInfo = {
          wants: [
            {
              bundleName: "com.qiniu.qplayer2demo",
              abilityName: "EntryAbility"
            }
          ],
          // 点击通知后,动作类型
          operationType: wantAgent.OperationType.START_ABILITY,
          requestCode: 0,
          // 点击通知后,动作执行属性
          wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
        };
    
        wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj : WantAgent) => {
          hilog.info(0x0000, 'testTag', '%{public}s', 'getWantAgent');
          backgroundTaskManager.startBackgroundRunning(this.context,
            backgroundTaskManager.BackgroundMode.AUDIO_PLAYBACK, wantAgentObj).then(() => {
            console.info("Operation startBackgroundRunning succeeded");
          }).catch((err: BusinessError) => {
            console.error("Operation startBackgroundRunning failed Cause: " + err);
          });
        });
      }
    

    后台播放权限申请

     {
        "name": "ohos.permission.KEEP_BACKGROUND_RUNNING"
     }
    
    以上内容是否对您有帮助?
  • Qvm free helper
    Close