云点播
容器与中间件专题文档捉虫活动邀您参加 > HOT
文档中心>云点播>开发指南>媒体上传>服务端上传>C# SDK

C# SDK

最近更新时间：2024-06-28 15:31:11

我的收藏

本页目录：

对于在服务端上传视频的场景，云点播提供 C# SDK 来实现。上传流程请参见 服务端上传指引。

集成方式

通过 nuget 安装

1. 通过命令行安装：
dotnet add package VodSDK --version 1.0.1
2. 通过 Visual Studio 的 nuget 包管理工具，搜索 VodSDK 并安装。

通过源码包安装

如果项目中没有使用 nuget 工具，可以直接下载源码导入项目中使用：
从 Github 访问
单击下载 C# SDK
下载最新代码，解压后安装到项目工作目录下，使用 Visual Studio 2017 打开编译。因为此 SDK 还依赖外部的包，所以需要同时安装如下 SDK：
云 API SDK
对象存储 SDK

简单上传

初始化一个上传客户端对象

使用云 API 密钥初始化 VodUploadClient 实例。
using System;
using VodSDK;

VodUploadClient client = new VodUploadClient("your secretId", "your secretKey");

构造上传请求对象

设置媒体本地上传路径。
VodUploadRequest request = new VodUploadRequest();
request.MediaFilePath = "/data/videos/Wildlife.wmv";

调用上传

调用上传方法，传入接入点地域及上传请求。
try 
{
    VodUploadResponse response = client.Upload("ap-guangzhou", request);
    // 打印媒体 FileId
    Console.WriteLine(response.FileId);
} 
catch (Exception e) 
{
    // 业务方进行异常处理
    Console.WriteLine(e);
}
说明：
上传方法根据用户文件的长度，自动选择普通上传以及分片上传，用户不用关心分片上传的每个步骤，即可实现分片上传。

高级功能

携带封面

using System;
using VodSDK;

VodUploadClient client = new VodUploadClient("your secretId", "your secretKey");
VodUploadRequest request = new VodUploadRequest();
request.MediaFilePath = "/data/videos/Wildlife.wmv";
request.CoverFilePath = "/data/videos/Wildlife.jpg";
try 
{
    VodUploadResponse response = client.Upload("ap-guangzhou", request);
    // 打印媒体 FileId
    Console.WriteLine(response.FileId);
} 
catch (Exception e) 
{
    // 业务方进行异常处理
    Console.WriteLine(e);
}

指定任务流

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

VodUploadClient client = new VodUploadClient("your secretId", "your secretKey");
VodUploadRequest request = new VodUploadRequest();
request.MediaFilePath = "/data/videos/Wildlife.wmv";
request.Procedure = "Your Procedure Name";
try 
{
    VodUploadResponse response = client.Upload("ap-guangzhou", request);
    // 打印媒体 FileId
    Console.WriteLine(response.FileId);
} 
catch (Exception e) 
{
    // 业务方进行异常处理
    Console.WriteLine(e);
}

应用上传

传入 应用 ID，上传成功后资源只属于具体的应用。
using System;
using VodSDK;

VodUploadClient client = new VodUploadClient("your secretId", "your secretKey");
VodUploadRequest request = new VodUploadRequest();
request.MediaFilePath = "/data/videos/Wildlife.wmv";
request.SubAppId = 101;
try 
{
    VodUploadResponse response = client.Upload("ap-guangzhou", request);
    // 打印媒体 FileId
    Console.WriteLine(response.FileId);
} 
catch (Exception e) 
{
    // 业务方进行异常处理
    Console.WriteLine(e);
}

指定存储地域

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

VodUploadClient client = new VodUploadClient("your secretId", "your secretKey");
VodUploadRequest request = new VodUploadRequest();
request.MediaFilePath = "/data/videos/Wildlife.wmv";
request.StorageRegion = "ap-chongqing";
try 
{
    VodUploadResponse response = client.Upload("ap-guangzhou", request);
    // 打印媒体 FileId
    Console.WriteLine(response.FileId);
} 
catch (Exception e) 
{
    // 业务方进行异常处理
    Console.WriteLine(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
资源不存在。

中国站
文档反馈
文档活动
message-icon联系我们
目录