音视频终端SDK：基础功能

创建播放器

本节介绍如何用更简单的方式让Flutter框架播放器SDK播放视频，按照播放方式的不同可以分为手动播放和自动播放。

1. 创建播放器。

   创建单实例播放器。

   //创建播放器实例
   FlutterAliplayer fAliplayer = FlutterAliPlayerFactory.createAliPlayer();
   //建议传入TraceID 
   fAliplayer.setTraceID("traceID");

   创建多实例播放器。

   需要在Flutter层管理playerId，在播放器的回调中会返回对应的playerId，用来通知Flutter层。

   FlutterAliplayer fAliplayer = FlutterAliPlayerFactory.createAliPlayer(playerId: playerId);

2. 设置监听器。

   播放器支持设置多个监听器。

   • 创建手动播放时，OnPrepard必须设置，因为手动播放需要在OnPrepard回调中调用play开始播放。

   • OnTrackReady、OnError较为重要，建议您设置。

   以下示例仅展示部分接口，如下所示：

   // 准备成功
   fAliplayer.setOnPrepard((playerId) {});
   // 首帧显示
   fAliplayer.setOnRenderingStart((playerId) {});
   // 视频宽高变化
   fAliplayer.setOnVideoSizeChanged((width, height,playerId) {});
   // 播放器状态变化
   fAliplayer.setOnStateChanged((newState,playerId) {});
   // 加载状态
   fAliplayer.setOnLoadingStatusListener(
       loadingBegin: (playerId) {},
       loadingProgress: (percent, netSpeed,playerId) {},
       loadingEnd: (playerId) {});
   // 拖动完成
   fAliplayer.setOnSeekComplete((playerId) {});
   // 播放器事件信息回调，包括buffer、当前播放进度等等信息，根据infoCode来判断，对应FlutterAvpdef.infoCode
   fAliplayer.setOnInfo((infoCode, extraValue, extraMsg,playerId) {});
   // 播放完成
   fAliplayer.setOnCompletion((playerId) {});
   // 设置流准备完成
   fAliplayer.setOnTrackReady((playerId) {});
   // 截图结果
   fAliplayer.setOnSnapShot((path,playerId) {});
   // 错误结果
   fAliplayer.setOnError((errorCode, errorExtra, errorMsg,playerId) {});
   // 切换流变化
   fAliplayer.setOnTrackChanged((value,playerId) {});

3. 创建播放源。

   • Flutter播放器SDK支持4种点播播放方式，包括：UrlSource播放、VidAuth播放（视频点播用户推荐使用）、VidSts播放、加密播放。

   • Flutter播放器SDK仅支持1种直播播放方式，为UrlSource播放。

   点播视频播放

   点播UrlSource播放

   使用点播UrlSource播放方式播放点播视频，需要将播放器的setUrl属性设置为播放地址。播放地址可以是第三方点播地址或阿里云点播服务中的播放地址。

   阿里云播放地址可以调用GetPlayInfo接口获取。建议您通过SDK方式来获取音视频播放地址，免去自签名的麻烦。调用接口获取音视频播放地址的示例请参见开发者门户。

   void onViewPlayerCreated(viewId) async {
     // 将渲染的View设置给播放器
     fAliplayer.setPlayerView(viewId);
     // 设置播放源
     switch (_playMode) {
         // UrlSource播放方式
       case ModeType.URL:
         this.fAliplayer.setUrl("播放地址"); // 必选参数，播放地址，可以是第三方点播地址，或阿里云点播服务中的播放地址。
         break;
       default:
     }
   }

   点播VidAuth播放（推荐）

   使用VidAuth播放方式播放点播视频，需要将播放器的vid属性设置为音视频ID，将playauth属性设置为音视频播放凭证。

   • 音视频ID可以在音视频上传完成后通过控制台（路径：媒资库>音/视频。）或服务端接口（SearchMedia）获取。

   • 音视频播放凭证可以调用GetVideoPlayAuth接口获取。建议您通过SDK方式来获取音视频播放凭证，免去自签名的麻烦。调用接口获取音视频播放凭证的示例请参见开发者门户。

   推荐视频点播用户采用此播放方式。相比STS播放方式，PlayAuth播放方式在易用性和安全性上更有优势，对比详情请参见凭证方式与STS方式对比。

   void onViewPlayerCreated(viewId) async {
     // 将渲染的View设置给播放器
     fAliplayer.setPlayerView(viewId);
     //请注意 generatePlayerConfig 之前必须调用 createVidPlayerConfigGenerator()
     FlutterAliplayer.createVidPlayerConfigGenerator();
     // 设置播放源
     FlutterAliplayer.generatePlayerConfig().then((value) {
         fAliplayer.setVidAuth(
             vid: "Vid信息",// 必选参数，视频ID（VideoId）。
             region: "接入地域",// 必选参数，点播服务的接入地域，默认为cn-shanghai。
             playAuth: "<yourPlayAuth>",// 必选参数，播放凭证，需要调用点播服务的GetVideoPlayAuth接口生成。
             playConfig: value);
           });    
     }
   }

   点播VidSts播放

   使用点播VidSts播放方式播放点播视频是指用STS临时凭证而非点播音视频播放凭证播放。STS安全令牌和STS临时AK对（AccessKeyId和AccessKeySecret）需要提前获取，获取方式请参见使用STS临时授权方案上传视频。

   void onViewPlayerCreated(viewId) async {
     // 将渲染的View设置给播放器
     fAliplayer.setPlayerView(viewId);
     //请注意 generatePlayerConfig 之前必须调用 createVidPlayerConfigGenerator()
     FlutterAliplayer.createVidPlayerConfigGenerator();
     // VidSts播放方式
     FlutterAliplayer.generatePlayerConfig().then((value) {
        fAliplayer.setVidSts(
             vid: "Vid信息",// 必选参数，视频ID（VideoId）。
             region: "接入地域",// 必选参数，点播服务的接入地域，默认为cn-shanghai。
             accessKeyId: "<yourAccessKeyId>",// 必选参数，STS临时AK对的访问密钥ID，需要调用STS服务的AssumeRole接口生成。
             accessKeySecret: "<yourAccessKeySecret>",// 必选参数，STS临时AK对的访问密钥，需要调用STS服务的AssumeRole接口生成。
             securityToken: "<yourSecurityToken>",// 必选参数，STS安全令牌，需要调用STS服务的AssumeRole接口生成。
         	  playConfig: value);
       	});
          
   }

   点播加密播放

   点播视频支持HLS标准加密、阿里云私有加密和DRM加密。加密播放请参见如何播放加密视频。

   直播视频UrlSource播放

   使用UrlSource播放方式播放直播视频，需要将播放器的setUrl属性设置为直播拉流地址。播放地址可以是第三方直播地址或阿里云直播服务中的拉流地址。

   阿里云直播拉流地址可以通过直播控制台的地址生成器生成。详情请参见阿里云直播地址生成器 。

   void onViewPlayerCreated(viewId) async {
     // 将渲染的View设置给播放器
     fAliplayer.setPlayerView(viewId);
     // 设置播放源
     switch (_playMode) {
       // UrlSource播放方式
       case ModeType.URL:
         this.fAliplayer.setUrl("填写资源的播放地址"); // 播放地址可以是第三方直播地址，或阿里云直播服务中的拉流地址。
         break;
       default:
     }
   }

4. 设置显示View。

   如果播放源有画面，那么需要设置显示的view到播放器中，用来显示画面。示例如下：

   @override
   Widget build(BuildContext context) {
     var x = 0.0;
     var y = 0.0;
     Orientation orientation = MediaQuery.of(context).orientation;
     var width = MediaQuery.of(context).size.width;
   
     var height;
     if (orientation == Orientation.portrait) {
       height = width * 9.0 / 16.0;
     } else {
       height = MediaQuery.of(context).size.height;
     }
     AliPlayerView aliPlayerView = AliPlayerView(
         onCreated: onViewPlayerCreated,
         x: x,
         y: y,
         width: width,
         height: height);
     return OrientationBuilder(
       builder: (BuildContext context, Orientation orientation) {
         return Scaffold(
           body: Column(
             children: [
               Container(
                   color: Colors.black,
                   child: aliPlayerView,
                   width: width,
                   height: height),
             ],
           ),
         );
       },
     );

5. 可选：开启自动播放，默认为关闭状态。

   fAliplayer.setAutoPlay(true);

6. 准备播放。

   调用prepare()方法准备播放。

   fAliplayer.prepare();

7. 开始播放。

   • 如果未开启自动播放，需要在OnPrepard回调中调用fAliplayer.play();开始播放视频。

   • 如果开启了自动播放，则不需要调用fAliplayer.play();，数据解析完成后将开始自动播放视频。

   fAliplayer.play();

控制播放

Flutter框架播放器SDK支持开始、暂停、从指定时间点播放等主流操作。

开始播放

 fAliplayer.play();

从指定时间开始播放

////posotion为指定的时间，单位：毫秒。seekMode取值：FlutterAvpdef.ACCURATE（精准seek）和FlutterAvpdef.INACCURATE（非精准seek）
fAliplayer.seek(position,seekMode);

暂停播放

fAliplayer.pause();

停止播放

fAliplayer.stop();

设置显示模式

Flutter框架播放器SDK支持填充、旋转、镜像等显示设置。

填充

//设置宽高比适应（将按照视频宽高比等比缩小到view内部，不会有画面变形）
fAliplayer.setScalingMode(FlutterAvpdef.AVP_SCALINGMODE_SCALEASPECTFIT);
//设置宽高比填充（将按照视频宽高比等比放大，充满view，不会有画面变形）
fAliplayer.setScalingMode(FlutterAvpdef.AVP_SCALINGMODE_SCALEASPECTFILL);
//设置拉伸填充（如果视频宽高比例与view比例不一致，会导致画面变形）
fAliplayer.setScalingMode(FlutterAvpdef.AVP_SCALINGMODE_SCALETOFILL);

旋转

//设置画面顺时针旋转0度
fAliplayer.setRotateMode(FlutterAvpdef.AVP_ROTATE_0);
//设置画面顺时针旋转90度
fAliplayer.setRotateMode(FlutterAvpdef.AVP_ROTATE_90);
//设置画面顺时针旋转180度
fAliplayer.setRotateMode(FlutterAvpdef.AVP_ROTATE_180);
//设置画面顺时针旋转270度
fAliplayer.setRotateMode(FlutterAvpdef.AVP_ROTATE_270);
//获取旋转角度
fAliplayer.getRotateMode();

镜像

//设置无镜像
fAliplayer.setMirrorMode(FlutterAvpdef.AVP_MIRRORMODE_NONE);
//设置水平镜像
fAliplayer.setMirrorMode(FlutterAvpdef.AVP_MIRRORMODE_HORIZONTAL);
//设置垂直镜像
fAliplayer.setMirrorMode(FlutterAvpdef.AVP_MIRRORMODE_VERTICAL); 

获取播放信息

Flutter框架播放器SDK支持获取当前的播放进度和播放时长。

获取当前播放进度

fAliplayer.setOnInfo((infoCode,extraValue,extraMsg,playerId){
 if(infoCode==FlutterAvpdef.CURRENTPOSITION){
 //extraValue为当前播放进度
}
});

获取播放时长

fAliplayer.getMediaInfo().then((value){
 _videoDuration=value['duration'];
});

监听播放状态

fAliplayer.setOnStateChanged((newState, playerId) {
  //newState为播放状态
  switch (newState) {
    case FlutterAvpdef.AVPStatus_AVPStatusIdle: // 空转、闲时、静态
      break;
    case FlutterAvpdef.AVPStatus_AVPStatusInitialzed: // 初始化完成
      break;
    case FlutterAvpdef.AVPStatus_AVPStatusPrepared: // 准备完成
      break;
    case FlutterAvpdef.AVPStatus_AVPStatusStarted: // 正在播放
      break;
    case FlutterAvpdef.AVPStatus_AVPStatusPaused: // 播放暂停
      break;
    case FlutterAvpdef.AVPStatus_AVPStatusStopped: // 播放停止
      break;
    case FlutterAvpdef.AVPStatus_AVPStatusCompletion: // 播放完成
      break;
    case FlutterAvpdef.AVPStatus_AVPStatusError: // 播放错误
      break;
    default:
  }
});

设置音量

设置音量包括音量调节和静音设置。

音量调节

//volume的值为0～2之间的实数。
fAliPlayer.setVolume(1);
//获取音量信息。
fAliPlayer.getVolume();

静音设置

fAliplayer.setMute(true);

倍速播放

//设置倍速播放：支持0.5～5倍速的播放，通常按0.5的倍数来设置，例如0.5倍、1倍、1.5倍等
fAliplayer.setRate(1.0);

多清晰度设置

如果使用VID方式（VidAuth（推荐）及VidSts）播放，无需额外设置。Flutter框架播放器SDK会从点播服务获取清晰度列表。Flutter框架播放器SDK支持获取和切换清晰度，UrlSource播放方式暂不支持此设置。

获取清晰度

fAliplayer.setOnPrepared((playerId) {
  fAliplayer.getMediaInfo().then((value){
        AVPMediaInfoinfo info=AVPMediaInfo.fromJson(value);
        info.tracks.forEach((element){
          if(element.trackType==3){
            // 清晰度
            String definition=element.trackDefinition;
            // 流索引
            int index=element.trackIndex;
          }
        });
      });    
});

切换清晰度

fAliplayer.selectTrack(trackIdx);

清晰度切换通知

fAliplayer.setOnTrackChanged((value,playerId){
 //有回调表示切换成功，切换失败接口暂未提供
});

循环播放

fAliplayer.setLoop(true);

fAliplayer.setOnInfo((infoCode, extraValue, extraMsg, playerId) {
 if(infoCode == FlutterAvpdef.LOOPINGSTART){
 //循环播放开始通知
 }
});

获取播放日志

//开启日志打印功能
FlutterAliplayer.enableConsoleLog(true);
//设置日志级别，默认为AF_LOG_LEVEL_INFO，如需排查问题，可设置为AF_LOG_LEVEL_TRACE
FlutterAliplayer.setLogLevel(FlutterAvpdef.AF_LOG_LEVEL_INFO);