云点播 PHP SDK

对于在服务端上传视频的场景,云点播提供 PHP SDK 来实现,请确认已准备依赖环境:PHP 5.6.33 及以上版本。上传流程。

相关产品
云点播 产品页,含版本规格、价格与购买入口。

一、使用 composer 引入

{ "require": { "qcloud/vod-sdk-v5": "v2.4.4" }}

二、通过源码包安装

·如果项目中没有使用 composer 工具进行依赖管理,从 Github 访问 可以直接下载源码,导入项目中使用。

·解压 vod-sdk.zip 文件到项目中,引入 autoload.php 文件即可使用。

三、初始化上传对象

使用云 API 密钥初始化 VodUploadClient 实例。

使用 composer 导入

<?phprequire 'vendor/autoload.php';use Vod\\VodUploadClient;$client = new VodUploadClient("your secretId", "your secretKey");

使用源码导入

<?phprequire 'vod-sdk-v5/autoload.php';use Vod\\VodUploadClient;$client = new VodUploadClient("your secretId", "your secretKey");

四、构造上传请求对象

use Vod\\Model\\VodUploadRequest;$req = new VodUploadRequest();$req->MediaFilePath = "/data/videos/Wildlife.wmv";

五、调用上传

调用上传方法,传入接入点地域及上传请求。

try { $rsp = $client->upload("ap-guangzhou", $req); echo "FileId -> ". $rsp->FileId . "\\n"; echo "MediaUrl -> ". $rsp->MediaUrl . "\\n";} catch (Exception $e) { // 处理上传异常 echo $e;}

注意:说明:

注意:上传方法根据用户文件的长度,自动选择普通上传以及分片上传,用户不用关心分片上传的每个步骤,即可实现分片上传。

六、携带封面

<?phprequire 'vendor/autoload.php';use Vod\\VodUploadClient;use Vod\\Model\\VodUploadRequest;$client = new VodUploadClient("your secretId", "your secretKey");$req = new VodUploadRequest();$req->MediaFilePath = "/data/videos/Wildlife.wmv";$req->CoverFilePath = "/data/videos/Wildlife-Cover.png";try { $rsp = $client->upload("ap-guangzhou", $req); echo "FileId -> ". $rsp->FileId . "\\n"; echo "MediaUrl -> ". $rsp->MediaUrl . "\\n"; echo "CoverUrl -> ". $rsp->CoverUrl . "\\n";} catch (Exception $e) { // 处理上传异常 echo $e;}

七、指定任务流

首先 创建任务流模板 并为模板命名,发起任务流时,可以用任务流模板名设置Procedure参数,上传成功后会自动执行任务流。

<?phprequire 'vendor/autoload.php';use Vod\\VodUploadClient;use Vod\\Model\\VodUploadRequest;$client = new VodUploadClient("your secretId", "your secretKey");$req = new VodUploadRequest();$req->MediaFilePath = "/data/videos/Wildlife.wmv";$req->Procedure = "Your Procedure Name";try { $rsp = $client->upload("ap-guangzhou", $req); echo "FileId -> ". $rsp->FileId . "\\n"; echo "MediaUrl -> ". $rsp->MediaUrl . "\\n";} catch (Exception $e) { // 处理上传异常 echo $e;}

八、应用上传

传入 应用 ID,上传成功后资源只属于具体的应用。

<?phprequire 'vendor/autoload.php';use Vod\\VodUploadClient;use Vod\\Model\\VodUploadRequest;$client = new VodUploadClient("your secretId", "your secretKey");$req = new VodUploadRequest();$req->MediaFilePath = "/data/videos/Wildlife.wmv";$req->SubAppId = 101;try { $rsp = $client->upload("ap-guangzhou", $req); echo "FileId -> ". $rsp->FileId . "\\n"; echo "MediaUrl -> ". $rsp->MediaUrl . "\\n";} catch (Exception $e) { // 处理上传异常 echo $e;}

九、指定存储地域

在 控制台 确认已经开通目标存储地域,若没有开通可以参考 上传存储设置,最后通过StorageRegion属性设置存储地域的 英文简称。

<?phprequire 'vendor/autoload.php';use Vod\\VodUploadClient;use Vod\\Model\\VodUploadRequest;$client = new VodUploadClient("your secretId", "your secretKey");$req = new VodUploadRequest();$req->MediaFilePath = "/data/videos/Wildlife.wmv";$req->StorageRegion = "ap-chongqing";try { $rsp = $client->upload("ap-guangzhou", $req); echo "FileId -> ". $rsp->FileId . "\\n"; echo "MediaUrl -> ". $rsp->MediaUrl . "\\n";} catch (Exception $e) { // 处理上传异常 echo $e;}

十、使用临时证书上传

传入 临时证书 的相关密钥信息,使用临时证书验证身份并进行上传。

<?phprequire 'vendor/autoload.php';use Vod\\VodUploadClient;use Vod\\Model\\VodUploadRequest;$client = new VodUploadClient("Credentials TmpSecretId", "Credentials TmpSecretKey", "Credentials Token");$req = new VodUploadRequest();$req->MediaFilePath = "/data/videos/Wildlife.wmv";try { $rsp = $client->upload("ap-guangzhou", $req); echo "FileId -> ". $rsp->FileId . "\\n"; echo "MediaUrl -> ". $rsp->MediaUrl . "\\n";} catch (Exception $e) { // 处理上传异常 echo $e;}

十一、设置代理上传

设置上传代理,涉及协议及数据都会经过代理进行处理,开发者可以借助代理在自己公司内网上传文件到腾讯云。

<?phprequire 'vendor/autoload.php';use Vod\\VodUploadClient;use Vod\\Model\\VodUploadRequest;use Vod\\Model\\VodUploadHttpProfile;$client = new VodUploadClient("your secretId", "your secretKey");$uploadHttpProfile = new VodUploadHttpProfile("your proxy addr");$client->setHttpProfile($uploadHttpProfile);$req = new VodUploadRequest();$req->MediaFilePath = "/data/videos/Wildlife.wmv";try { $rsp = $client->upload("ap-guangzhou", $req); echo "FileId -> ". $rsp->FileId . "\\n"; echo "MediaUrl -> ". $rsp->MediaUrl . "\\n";} catch (Exception $e) { // 处理上传异常 echo $e;}

十二、自适应码流文件上传

本 SDK 支持上传的自适应码流格式包括 HLS 和 DASH,同时要求 manifest(M3U8 或 MPD)所引用的媒体文件必须为相对路径(即不可以是 URL 和绝对路径),且位于 manifest 的同级目录或者下级目录(即不可以使用../)。在调用 SDK 上传接口时,MediaFilePath参数填写 manifest 路径,SDK 会解析出相关的媒体文件列表一并上传。

<?phprequire 'vendor/autoload.php';use Vod\\VodUploadClient;use Vod\\Model\\VodUploadRequest;$client = new VodUploadClient("your secretId", "your secretKey");$req = new VodUploadRequest();$req->MediaFilePath = "/data/videos/prog_index.m3u8";try { $rsp = $client->upload("ap-guangzhou", $req); echo "FileId -> ". $rsp->FileId . "\\n"; echo "MediaUrl -> ". $rsp->MediaUrl . "\\n";} catch (Exception $e) { // 处理上传异常 echo $e;}

十三、接口描述

上传客户端类VodUploadClient

属性名称 属性描述 类型 必填
secretId 云 API 密钥 ID String 是
secretKey 云 API 密钥 Key String 是

上传请求类VodUploadRequest

属性名称 属性描述 类型 必填
MediaFilePath 待上传的媒体文件路径。必须为本地路径,不支持 URL。 String 是
SubAppId 云点播 应用 ID。如果要访问应用中的资源,则将该字段填写为应用 ID,否则无需填写该字段。 Integer 否
MediaType 待上传的媒体文件类型,可选类型请参见 媒体上传综述,若 MediaFilePath 路径带后缀可不填。 String 否
MediaName 上传后的媒体名称,若不填默认采用 MediaFilePath 的文件名。 String 否
CoverFilePath 待上传的封面文件路径。必须为本地路径,不支持 URL。 String 否
CoverType 待上传的封面文件类型,可选类型请参见 媒体上传综述,若 CoverFilePath 路径带后缀可不填。 String 否
Procedure 上传后需要自动执行的任务流名称,该参数在创建任务流(API 方式 或 控制台方式)时由用户指定。具体请参考 任务流综述。 String 否
ExpireTime 媒体文件过期时间,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明。 String 否
ClassId 分类 ID,用于对媒体进行分类管理,可通过 创建分类 接口,创建分类,获得分类 ID。 Integer 否
SourceContext 来源上下文,用于透传用户请求信息,上传回调接口将返回该字段值,最长250个字符。 String 否
StorageRegion 存储地域,指定预期希望存储的地域,该字段填写为存储地域的 英文简称。 String 否

上传响应类VodUploadResponse

属性名称 属性描述 类型
FileId 媒体文件的唯一标识。 String
MediaUrl 媒体播放地址。 String
CoverUrl 媒体封面地址。 String
RequestId 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 String

上传方法VodUploadClient.upload(String region, VodUploadRequest request)

参数名称 参数描述 类型 必填
region 接入点地域,即请求到哪个地域的云点播服务器,不同于存储地域,具体参考支持的 地域列表。 String 是
request 上传请求。 VodUploadRequest 是

十四、错误码表

状态码 含义
InternalError 内部错误。
InvalidParameter.ExpireTime 参数值错误:过期时间。
InvalidParameterValue.CoverType 参数值错误:封面类型。
InvalidParameterValue.MediaType 参数值错误:媒体类型。
InvalidParameterValue.SubAppId 参数值错误:应用 ID。
InvalidParameterValue.VodSessionKey 参数值错误:点播会话。
ResourceNotFound 资源不存在。
赞 (0)
上一篇 4天前
下一篇 4天前