tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
云点播
    文档
    Download PDF

    Python SDK

    最后更新时间：2022-06-24 16:07:16
    下载PDF
      对于在服务端上传视频的场景，云点播提供 Python SDK 来实现。上传流程请参见 服务端上传指引。

      集成方式

      使用 pip 安装

      pip install vod-python-sdk

      通过源码包安装

      如果项目中没有使用 pip 工具，可以直接下载源码导入项目中使用：
      从 Github 访问
      单击下载 Python SDK
      下载最新代码，解压后：
      $ cd vod-python-sdk
      $ python setup.py install

      简单视频上传

      初始化上传对象

      使用云 API 密钥初始化 VodUploadClient 实例。
      from qcloud_vod.vod_upload_client import VodUploadClient
      
      client = VodUploadClient("your secretId", "your secretKey")

      构造上传请求对象

      from qcloud_vod.model import VodUploadRequest
      
      request = VodUploadRequest()
      request.MediaFilePath = "/data/file/Wildlife.mp4"

      调用上传

      调用上传方法，传入接入点地域及上传请求。
      try:
          response = client.upload("ap-guangzhou", request)
          print(response.FileId)
          print(response.MediaUrl)
      except Exception as err:
          # 处理业务异常
          print(err)
      说明：
      上传方法根据用户文件的长度，自动选择普通上传以及分片上传，用户不用关心分片上传的每个步骤，即可实现分片上传。

      高级功能

      携带封面

      from qcloud_vod.vod_upload_client import VodUploadClient
      from qcloud_vod.model import VodUploadRequest
      
      client = VodUploadClient("your secretId", "your secretKey")
      request = VodUploadRequest()
      request.MediaFilePath = "/data/file/Wildlife.mp4"
      request.CoverFilePath = "/data/file/Wildlife-Cover.png"
      try:
          response = client.upload("ap-guangzhou", request)
          print(response.FileId)
          print(response.MediaUrl)
          print(response.CoverUrl)
      except Exception as err:
          # 处理业务异常
          print(err)

      指定任务流

      首先 创建任务流模板 并为模板命名，发起任务流时，可以用任务流模板名设置Procedure参数，上传成功后会自动执行任务流。
      from qcloud_vod.vod_upload_client import VodUploadClient
      from qcloud_vod.model import VodUploadRequest
      
      client = VodUploadClient("your secretId", "your secretKey")
      request = VodUploadRequest()
      request.MediaFilePath = "/data/file/Wildlife.mp4"
      request.Procedure = "Your Procedure Name"
      try:
          response = client.upload("ap-guangzhou", request)
          print(response.FileId)
          print(response.MediaUrl)
      except Exception as err:
          # 处理业务异常
          print(err)

      子应用上传

      传入 子应用 ID，上传成功后资源只属于具体的子应用。
      from qcloud_vod.vod_upload_client import VodUploadClient
      from qcloud_vod.model import VodUploadRequest
      
      client = VodUploadClient("your secretId", "your secretKey")
      request = VodUploadRequest()
      request.MediaFilePath = "/data/file/Wildlife.mp4"
      request.SubAppId = 101
      try:
          response = client.upload("ap-guangzhou", request)
          print(response.FileId)
          print(response.MediaUrl)
      except Exception as err:
          # 处理业务异常
          print(err)

      指定存储地域

      在 控制台 确认已经开通目标存储地域，若没有开通可以参考 上传存储设置，最后通过StorageRegion属性设置存储地域的 英文简称。
      from qcloud_vod.vod_upload_client import VodUploadClient
      from qcloud_vod.model import VodUploadRequest
      
      client = VodUploadClient("your secretId", "your secretKey")
      request = VodUploadRequest()
      request.MediaFilePath = "/data/file/Wildlife.mp4"
      request.StorageRegion = "ap-chongqing"
      try:
          response = client.upload("ap-guangzhou", request)
          print(response.FileId)
          print(response.MediaUrl)
      except Exception as err:
          # 处理业务异常
          print(err)

      指定分片并发数

      分片并发数是针对大文件，拆分成多个分片同时进行上传。分片并发上传的优势在于可以快速完成单个文件的上传，SDK 会根据用户文件的长度，自动选择普通上传以及分片上传，用户不用关心分片上传的每个步骤，即可实现分片上传。而文件的分片并发数通过ConcurrentUploadNumber参数进行指定。
      from qcloud_vod.vod_upload_client import VodUploadClient
      from qcloud_vod.model import VodUploadRequest
      
      client = VodUploadClient("your secretId", "your secretKey")
      request = VodUploadRequest()
      request.MediaFilePath = "/data/file/Wildlife.mp4"
      request.ConcurrentUploadNumber = 5
      try:
          response = client.upload("ap-guangzhou", request)
          print(response.FileId)
          print(response.MediaUrl)
      except Exception as err:
          # 处理业务异常
          print(err)

      使用临时证书上传

      传入临时证书的相关密钥信息，使用临时证书验证身份并进行上传。
      from qcloud_vod.vod_upload_client import VodUploadClient
      from qcloud_vod.model import VodUploadRequest
      
      client = VodUploadClient("Credentials TmpSecretId", "Credentials TmpSecretKey", "Credentials Token")
      request = VodUploadRequest()
      request.MediaFilePath = "/data/file/Wildlife.mp4"
      try:
          response = client.upload("ap-guangzhou", request)
          print(response.FileId)
          print(response.MediaUrl)
      except Exception as err:
          # 处理业务异常
          print(err)

      自适应码流文件上传

      本 SDK 支持上传的自适应码流格式包括 HLS 和 DASH，同时要求 manifest（M3U8 或 MPD）所引用的媒体文件必须为相对路径（即不可以是 URL 和绝对路径），且位于 manifest 的同级目录或者下级目录（即不可以使用../）。在调用 SDK 上传接口时，MediaFilePath参数填写 manifest 路径，SDK 会解析出相关的媒体文件列表一并上传。
      from qcloud_vod.vod_upload_client import VodUploadClient
      from qcloud_vod.model import VodUploadRequest
      
      client = VodUploadClient("your secretId", "your secretKey")
      request = VodUploadRequest()
      request.MediaFilePath = "/data/file/prog_index.mp4"
      try:
          response = client.upload("ap-guangzhou", request)
          print(response.FileId)
          print(response.MediaUrl)
      except Exception as err:
          # 处理业务异常
          print(err)

      接口描述

      上传客户端类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
      否
      ConcurrentUploadNumber
      分片并发数，针对大文件分片时有效。
      Integer
      否
      上传响应类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
      资源不存在。
      联系我们

      联系我们，为您的业务提供专属服务。

      联系我们
      技术支持

      如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

      提交工单
      7x24 电话支持
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      隐私条款服务条款缓存条款