SDK for Java 使用指南

Transcription

1 目录 目录 目录 SDK for Java 使用指南安装 Java SDK 1.git 安装 2.mvn 中央仓库安装 3. 工程使用 sdk 录建议使用 Maven 构建自己的项目, 导入 ksc-sdk-java, 添加 ksc-sdk-java-kvs 的依赖 新建 maven 项目进入到 pom 文件下, 进行如下配置 4. 通过文件配置及管理密钥本地文件配置 : 该文件包含下述内容 : 如不通过本地文件读入 ak 和 sk 信息, 则需要在执行的类文件中增加以下代码 : SDK 介绍和使用在调用接口前, 先初始化 KSCKVSJsonClient, 如下用例 : 注 : 接口的传递的参数及返回值请参考 视频云离线转码接入文档 API 接口说明创建模板更新模板删除模板查询模板列表查询模板详情创建任务置顶任务删除任务查询任务列表查询任务详情查询任务 META 列表安装 Python SDK 1.git 安装 2.pip 安装 3. 通过文件配置及管理密钥 4. 创建一个 session ( 初始化 ) 6. 运行环境注 : 接口的传递的参数及返回值请参考 视频云离线转码接入文档 API 接口说明创建模板更新模板查询模板列表查询模板详情删除模板创建任务置顶任务删除任务查询任务列表查询任务详情查询任务 META 列表概述初始化注 : 接口的传递的参数及返回值请参考 视频云离线转码接入文档 API 接口说明创建模板更新模板删除模板查询模板列表查询模板详情创建任务置顶任务删除任务查询任务列表查询任务详情查询任务 META 列表 1. 概述 2. 初始化注 : 接口的传递的参数及返回值请参考 视频云直播转码接入说明 API 接口说明 3. 添加模板 4. 修改模板 5. 删除模板 6. 查询模板列表 7. 查询模板详情 8. 获取任务列表 9. 发起外网拉流 金山云 1/51

2 目录 停止外网拉流 11. 发起轮播 12. 停止轮播 13. 更新轮播时长 14. 获取轮播列表 15. 获取配额使用数据安装 python sdk 1.git 安装 2.pip 安装 3. 通过文件配置及管理密钥 4. 创建一个 session ( 初始化 ) 6. 运行环境 SDK 介绍和使用接口目录说明注 : 接口的传递的参数及返回值请参考 视频云直播转码接入说明 API 接口说明 1. 创建和更新模板 2. 删除模板 3. 查询模板列表 4. 查询模板详情 5. 获取任务列表 6. 发起外网拉流 7. 停止外网拉流 8. 发起轮播 9. 停止轮播 10. 更新轮播时长 11. 查询轮播列表 12. 获取配额使用数据 13. 创建选流任务 14. 更新选流任务 15. 查询选流任务 16. 删除选流任务安装 java sdk 1.git 安装 2.mvn 中央仓库安装 3. 工程使用 sdk 录建议使用 Maven 构建自己的项目, 导入 ksc-sdk-java, 添加 ksc-sdk-java-ket 的依赖 新建 maven 项目进入到 pom 文件下, 进行如下配置 4. 通过文件配置及管理密钥本地文件配置 : 该文件包含下述内容 : 如不通过本地文件读入 ak 和 sk 信息, 则需要在执行的类文件中增加以下代码 : SDK 介绍和使用在调用接口前, 先初始化 KSCOFFJsonClient, 如下用例 : SDK 介绍和使用接口目录说明注 : 接口的传递的参数及返回值请参考 视频云直播转码接入说明 API 接口说明 1. 创建和更新模板 2. 删除模板 3. 查询模板列表 4. 查询模板详情 5. 获取任务列表 6. 发起外网拉流 7. 停止外网拉流 8. 发起轮播 9. 停止轮播 10. 更新轮播时长 11. 获取轮播列表 12. 获取配额使用数据 13. 创建选流任务 14. 更新选流任务 15. 查询选流任务 16. 删除选流任务 金山云 2/51

3 S DK for Java 使用指南 安装 Java SDK 添加模板 更新模板 删除模板 查询模板列表 查询模板详情 创建任务 置顶任务 删除任务 查询任务列表 查询任务详情 查询任务 META 信息 安装 J a va SDK 1.git 安装 git clone mvn clean install 2.m vn 中央仓库安装 设置 pom 文件即可 3. 工程使用 sdk 录 建议使用 Ma ven 构建自己的项目, 导入 ksc-sdk-ja va, 添加 ksc-sdk-ja va -kvs 的依赖 新建 ma ven 项目 进入到 po m 文件下, 进行如下配置 <dependencies> <dependency> <groupid>com.ksyun</groupid> <artifactid>ksc-sdk-java-kvs</artifactid> <version>0.2.6</version> </dependency> </dependencies> 4. 通过文件配置及管理密钥 金山云 3/51

4 本地文件配置 : ~/.aws/credentials on Linux, OS X or unix C:\Users\USERNAME\.aws\credentials on Windows 该文件包含下述内容 : [default] aws_access_key_id = your_access_key_id aws_secret_access_key = your_secret_access_key 如不通过本地文件读入 a k 和 sk 信息, 则需要在执行的类文件中增加以下代码 : AWSCredentials credentials = new BasicAWSCredentials(aws_access_key_id, aws_secret_access_key); SDK 介绍和使用 在调用接口前, 先初始化 KS C KVS Jso nc lient, 如下用例 : KSCKVSJsonClient ksc = new KSCKVSJsonClient(); // 可传入 AWSCredentials 参数如 :KSCKVSJsonClient ksc = new KSCKVSJsonClient(credentials); ksc.setendpoint(" 字符集 :utf-8 注 : 接口的传递的参数及返回值请参考 视频云离线转码接入文档 API 接口说明 创建模板 Preset 金山云 4/51

5 PresetRequest presetrequest = new PresetRequest(); String data = PresetSet("xxx"); presetrequest.setdata(data); KvsErrResult presetresult = ksc.preset(presetrequest); // 请求内容生成接口 private static String PresetSet(String preset) throws JSONException { String presettype = "xxx"; JSONObject data = new JSONObject(); JSONObject param = new JSONObject(); JSONObject video = new JSONObject(); JSONObject audio = new JSONObject(); JSONArray logos = new JSONArray(); data.put("preset", "xxx"); data.put("presettype", "xxx"); data.put("description", "xxx"); video.put("vr", "13"); video.put("vb", "780000"); video.put("vcodec", "h264"); for (int i = 0; i < 4; i++) { JSONArray logo = new JSONArray(); for (int j = 0; j < 2; j++) { JSONObject tmp = new JSONObject(); tmp.put("url", String.valueOf(i) + ":" + String.valueOf(j)); tmp.put("ss", i + j); logo.put(tmp); logos.put(logo); audio.put("ar", "xxx"); audio.put("ab", "xxx"); audio.put("acodec", "aac"); audio.put("an", 0); param.put("f", "xxx"); param.put("video", video); param.put("audio", audio); param.put("logos", logos); data.put("param", param); return data.tostring(); 更新模板 UpdatePreset UpdatePresetRequest presetrequest = new UpdatePresetRequest(); String data = PresetSet("xxx"); presetrequest.setdata(data1); KvsErrResult presetresult = ksc.updatepreset(presetrequest); 删除模板 DelPreset 金山云 5/51

6 DeletePresetRequest deletepresetrequest = new DeletePresetRequest(); deletepresetrequest.setpreset("xxx"); KvsErrResult deletepresetresult = ksc.delpreset(deletepresetrequest); 查询模板列表 GetPresetList GetListRequest gitlistrequest = new GetListRequest(); gitlistrequest.setwithdetail(1); KvsResult getpresetlistresult = ksc.getpresetlist(gitlistrequest); 查询模板详情 GetPresetDetail GetPresetDetailRequest getpresetdetailrequest = new GetPresetDetailRequest(); getpresetdetailrequest.setpreset("xxx"); GetPresetDetailResult getpresetdetailresult = ksc.getpresetdetail(getpresetdetailrequest); 创建任务 CreateTask 金山云 6/51

7 CreateTaskRequest createtaskrequest = new CreateTaskRequest(); String data2 = settask("xxx", "xxx", "xxx", "xxx"); createtaskrequest.setdata(data2); CreateTasklResult createtasklresult = ksc.createtask(createtaskrequest); // 请求内容生成接口 private static String settask(string preset, String dst_bucket, String dst_object_key, String src_object_k ey) throws JSONException { JSONObject data = new JSONObject(); data.put("preset", preset); data.put("srcinfo", TaskSrcInfo(dst_bucket, src_object_key)); data.put("dstbucket", dst_bucket); data.put("dstobjectkey", dst_object_key); data.put("dstdir", ""); data.put("istop", 0); data.put("dstacl", "public-read"); data.put("cburl", ""); data.put("cbmethod", "POST"); data.put("extparam", ""); return data.tostring(); 置顶任务 TopTaskByTaskID TopTaskByTaskIDRequest toptaskbytaskidrequest = new TopTaskByTaskIDRequest(); toptaskbytaskidrequest.settaskid("xxx"); KvsErrResult TopTaskByTaskIDResult = ksc.toptaskbytaskid(toptaskbytaskidrequest); 删除任务 DelTaskByTaskID DelTaskByTaskIDRequest deltaskbytaskidrequest = new DelTaskByTaskIDRequest(); deltaskbytaskidrequest.settaskid("xxx"); KvsErrResult DelTaskByTaskIDResult = ksc.deltaskbytaskid(deltaskbytaskidrequest); 查询任务列表 GetTaskList 金山云 7/51

8 GetPresetListRequest getpresetlistrequest = new GetPresetListRequest(); getpresetlistrequest.setwithdetail(1); GetPresetListResult getpresetlistresult = ksc.getpresetlist(getpresetlistrequest); 查询任务详情 GetTaskByTaskID GetTaskByTaskIDRequest gettaskbytaskidrequest = new GetTaskByTaskIDRequest(); gettaskbytaskidrequest.settaskid("xxx"); GetTaskByTaskIDResult gettaskbytaskidresult = ksc.gettaskbytaskid(gettaskbytaskidrequest); 查询任务 META 列表 GetTaskMetaInfo GetTaskMetaRequest gettaskmetainforequest = new GetTaskMetaRequest(); gettaskmetainforequest.settaskid("xxx"); GetTaskMetaResult GetTaskMetaResult = ksc.gettaskmetainfo(gettaskmetainforequest); 安装 Python SDK 添加模板 更新模板 删除模板 查询模板列表 查询模板详情 创建任务 置顶任务 删除任务 查询任务列表 查询任务详情 查询任务 META 信息 安装 Python SDK 1.git 安装 金山云 8/51

9 git clone cd ksc-sdk-python python setup.py install 2.pip 安装 pip install ksc-sdk-python 3. 通过文件配置及管理密钥 所在位置 : '/etc/kscore.cfg' 或 './.kscore.cfg' 注意 : 使用相对路径时, 需与运行目录保持一致 ks_access_key_id 和 ks_secret_access_key 是金山云控制台身份与管理里面生成密钥对 [Credentials] ks_access_key_id=xxxxxxxxxxxxxxxxxxxx ks_secret_access_key=xxxxxxxxxxxxxxxxxxxx 4. 创建一个 session ( 初始化 ) from kscore.kvs import getkvsclient 第一种 : client = getkvsclient("kvs", "cn-beijing-6",use_ssl=false) 参数说明 : service_name: 服务名, 填写 "kvs" region_name: 区域名, 填写 "cn-beijing-6" use_ssl: 是否 https 访问, 填写 False 第二种 : 没有配置 kscore.cfg ks_access_key_id='xxxxxxxxxxxxxxxxxxxx' ks_secret_access_key='xxxxxxxxxxxxxxxxxxxx' 参数 : 服务 service_name, 大区 region_name client = getkvsclient("kvs", "cn-beijing-6",use_ssl=false,ks_access_key_id=ks_access_key_id,ks_secret_acce ss_key=ks_secret_access_key) 6. 运行环境 适用于 的 Python 版本 注 : 接口的传递的参数及返回值请参考 视频云离线转码接入文档 API 接口说明 创建模板 Preset 金山云 9/51

10 param = { "Preset": "xxxx", "Description": "xxxx", "PresetType": "xxxx", "Param":{ "f": "xxx", "AUDIO": { "ab": xxx, "ar": xxx, "acodec": "xxxx", "an": xxx, "VIDEO": { "vr": xxx, "vb": "xxxx", "vcodec": "xxxx", "width": xxx, "height": xxx, "as": xxx, "rotate": "xxxx", "vn": xxx 注 : 1.param 必须是 json 格式数据 res = client.preset(param) 更新模板 UpdatePreset 金山云 10/51

11 param = { "Preset": "xxxx", "Description": "xxxx", "PresetType": "xxxx", "Param":{ "f": "xxx", "AUDIO": { "ab": xxx, "ar": xxx, "acodec": "xxxx", "an": xxx, "VIDEO": { "vr": xxx, "vb": "xxxx", "vcodec": "xxxx", "width": xxx, "height": xxx, "as": xxx, "rotate": "xxxx", "vn": xxx 注 : 1.param 必须是 json 格式数据 res = client.updatepreset(param) 查询模板列表 GetPresetList res = client.getpresetlist(withdetail=0,presettype="xxx",presets="xxx") 查询模板详情 GetPresetDetail res = client.getpresetdetail(preset="xxx") 删除模板 DelPreset 金山云 11/51

12 res = client.delpreset(preset="xxx") 创建任务 CreateTask task = { "DstDir": "", "DstObjectKey": "xxx", "DstBucket": "xxx", "DstAcl": "public-read", "Preset": "xxx", "SrcInfo": [ { "path": "xxx", "type": "video", "index": 0 ], "CbMethod": "xxx", "CbUrl": "xxx" 注 : 1.task 必须是 json 格式数据 res = client.createtask(task) 置顶任务 TopTaskByTaskID res = client.toptaskbytaskid(taskid = taskid) 删除任务 DelTaskByTaskID res = client.deltaskbytaskid(taskid = taskid) 查询任务列表 金山云 12/51

13 GetTaskList res = client.gettasklist(startdate= ,enddate= ,marker=0,limit=50) 查询任务详情 GetTaskByTaskID res = client.gettaskbytaskid(taskid = taskid) 查询任务 META 列表 GetTaskMetaInfo 概述 res = client.gettaskmetainfo(startdate= ,enddate= ,marker=0,limit=50) 初始化 创建模板 更新模板 删除模板 查询模板列表 查询模板详情 创建任务 置顶任务 删除任务 查询任务列表 查询任务详情 查询任务 META 信息 概述 此 SDK 适用于 PHP 5.5 及以上版本 基于离线转码 API 构建 使用此 SDK 构建您的网络应用程序, 能让您以非常便捷地方 金山云 13/51

14 式调用金山云的离线转码服务 初始化 a k/sk 配置 在金山云控制台获取到 ak/sk 后创建以下文件 : mkdir ~/.ksyun && vi ~/.ksyun/config config 文件内容 { "ak":"********************", "sk":"****************************************" co m po ser 安装 mkdir test && cd test composer require kscsdk/ksyun_sdk 如果需要使用最新版本, 安装完之后, 修改 composer.json 为 { "require": { "kscsdk/ksyun_sdk": "dev-master" 然后再执行更新操作 composer update 调试 dem o cp vendor/kscsdk/ksyun_sdk/examples/demo_kvs.php. php demo_kvs.php GetPresetList 调用示例 use Ksyun\Service\Kvs; $response = Kvs::getInstance()->request('GetPresetList'); 注 : 接口的传递的参数及返回值请参考 视频云离线转码接入文档 API 接口说明 金山云 14/51

15 创建模板 Preset use Ksyun\Service\Kvs; // 拼凑模板数组 $preset_data = array( 'Preset' => 'xxx', 'Description' => 'xxx', 'PresetType' => 'xxx', 'Param' => array( 'f' => 'xxx', 'VIDEO' => array( 'vr' => '13', 'vb' => '780000', 'vcodec' => 'h264', 'width' => 500, 'height' => 600 ), 'AUDIO' => array( 'ar' => '44100', 'ab' => '64k', 'acodec' => 'aac', 'an' => 0 ) ) ); $response = Kvs::getInstance()->request('Preset', ['json' => $preset_data]); 更新模板 UpdatePreset 金山云 15/51

16 use Ksyun\Service\Kvs; // 拼凑模板数组 $preset_data = array( 'Preset' => 'xxx', 'Description' => 'xxx', 'PresetType' => 'xxx', 'Param' => array( 'f' => 'xxx', 'VIDEO' => array( 'vr' => '13', 'vb' => '780000', 'vcodec' => 'h264', 'width' => 500, 'height' => 600 ), 'AUDIO' => array( 'ar' => '44100', 'ab' => '64k', 'acodec' => 'aac', 'an' => 0 ) ) ); $response = Kvs::getInstance()->request('UpdatePreset', ['json' => $preset_data]); 删除模板 DelPreset use Ksyun\Service\Kvs; $response = Kvs::getInstance()->request('DelPreset', ['query' => ['Preset' => 'xxx']]); 查询模板列表 GetPresetList 金山云 16/51

17 use Ksyun\Service\Kvs; $response = Kvs::getInstance()->request('GetPresetList', ['query' => ['PresetType' => 'xxx', 'Presets' => 'xxx']]); 查询模板详情 GetPresetDetail use Ksyun\Service\Kvs; $response = Kvs::getInstance()->request('GetPresetDetail', ['query' => ['Preset' => 'xxx']]); 创建任务 CreateTask 金山云 17/51

18 use Ksyun\Service\Kvs; // 拼凑参数数组 $task_data = array( 'preset' => 'xxx', 'srcinfo' => array( array( 'path' => 'xxx', 'index' => 0, 'type' => 'video', ) ), 'dstbucket' => 'xxx', 'dstdir' => '', 'dstobjectkey' => 'xxx', 'dstacl' => 'public-read', 'istop' => 0, 'cburl' => '', 'cbmethod' => '', 'extparam' => '' ); $response = Kvs::getInstance()->request('CreateTask', ['json' => $task_data]); 置顶任务 TopTaskByTaskID use Ksyun\Service\Kvs; $response = Kvs::getInstance()->request('TopTaskByTaskID', ['query' => ['TaskID' => 'xxx']]); 删除任务 DelTaskByTaskID 金山云 18/51

19 use Ksyun\Service\Kvs; $response = Kvs::getInstance()->request('DelTaskByTaskID', ['query' => ['TaskID' => 'xxx']]); 查询任务列表 GetTaskList use Ksyun\Service\Kvs; $response = $response = Kvs::getInstance()->request('GetTaskList', ['query' => ['StartDate' => ' ', 'EndDate' => ' ', 'Marker' => 0, 'Limit' => 2]]); 查询任务详情 GetTaskByTaskID use Ksyun\Service\Kvs; $response = Kvs::getInstance()->request('GetTaskByTaskID', ['query' => ['TaskID' => 'xxx']]); 查询任务 META 列表 GetTaskMetaInfo 金山云 19/51

20 use Ksyun\Service\Kvs; // 通过任务 ID 查询 $response = Kvs::getInstance()->request('GetTaskMetaInfo', ['query' => ['TaskID' => 'xxx']]); // 查询列表 $response = Kvs::getInstance()->request('GetTaskMetaInfo', ['query' => ['StartDate' => ' ', 'EndDat e' => ' ', 'Marker' => 0, 'Limit' => 1]]); 版本 时间 更新内容 V /12/14 新建 V /2/7 修改参数名及返回值为大驼峰 V /3/30 新增更新模版接口 V /4/27 新增轮播相关接口 1. 概述 此 SDK 适用于 PHP 5.5 及以上版本 基于直播转码 API 构建 使用此 SDK 构建您的网络应用程序, 能让您以非常便捷地方 式调用金山云的直播转码服务 2. 初始化 2.1 a k/sk 配置 在金山云控制台获取到 ak/sk 后创建以下文件 : mkdir ~/.ksyun && vi ~/.ksyun/config config 文件内容 { "ak":"********************", "sk":"****************************************" 2.2 co m po ser 安装 mkdir test && cd test composer require kscsdk/ksyun_sdk 如果需要使用最新版本, 安装完之后, 修改 composer.json 为 金山云 20/51

21 { "require": { "kscsdk/ksyun_sdk": "dev-master" 然后再执行更新操作 composer update 2.3 调试 dem o cp vendor/kscsdk/ksyun_sdk/examples/demo_ket.php. php demo_ket.php GetPresetList 2.4 调用示例 use Ksyun\Service\Ket; $response = Ket::getInstance()->request('GetPresetList'); 注 : 接口的传递的参数及返回值请参考 视频云直播转码接入说明 API 接口说明 3. 添加模板 调用示例 use Ksyun\Service\Ket; $app = 'live'; // 频道名 $uniqname = 'test'; // 用户名 $preset = 'preset_demo'; // 模板名 $preset_data = [ 'Preset' => $preset, 'App' => $app, 金山云 21/51

22 'Description' => 'desc: preset demo', 'Output' => [ [ 'format' => [ 'output_format' => 256, 'abr' => 60000, 'vbr' => , 'fr' => 25, 'logo_switch' => 1 ] ], [ 'format' => [ 'output_format' => 257, 'abr' => 70000, 'vbr' => , 'fr' => 23, 'logo_switch' => 0 ] ] ], 'Video' => [ 'logo' => [ [ 'pic' => 'wangshuai9/ksyun.png', 'short_side' => 480, 'disable_scale' => 0, 'offsetx' => 10, 'offsety' => -20 ] ] ] 金山云 22/51

23 ] ]; $response = Ket::getInstance()->request('Preset', ['query' => ['Uniqname' => $uniqname], 'json' => $preset _data]); 4. 修改模板 调用示例 use Ksyun\Service\Ket; $app = 'live'; // 频道名 $uniqname = 'test'; // 用户名 $preset = 'preset_demo'; // 模板名 $preset_data = [ 'Preset' => $preset, 'App' => $app, 'Description' => 'desc: preset demo', 'Output' => [ [ 'format' => [ 'output_format' => 256, 'abr' => 60000, 'vbr' => , 'fr' => 25, 'logo_switch' => 1 ] ], [ 'format' => [ 'output_format' => 257, 'abr' => 70000, 'vbr' => , 金山云 23/51

24 'fr' => 23, 'logo_switch' => 0 ] ] ], 'Video' => [ 'logo' => [ [ 'pic' => 'wangshuai9/ksyun.png', 'short_side' => 480, 'disable_scale' => 0, 'offsetx' => 10, 'offsety' => -20 ] ] ] ]; $response = Ket::getInstance()->request('UpdatePreset', ['query' => ['Uniqname' => $uniqname], 'json' => $ preset_data]); 5. 删除模板 调用示例 use Ksyun\Service\Ket; $app = 'live'; // 频道名 $uniqname = 'test'; // 用户名 $preset = 'preset_demo'; // 模板名 $response = Ket::getInstance()->request('DelPreset', ['query' => ['Uniqname' => $uniqname, 'App' => $app, 'Preset' => $preset]]); 金山云 24/51

25 6. 查询模板列表 调用示例 use Ksyun\Service\Ket; $app = 'live'; // 频道名 $uniqname = 'test'; // 用户名 $response = Ket::getInstance()->request('GetPresetList', ['query' => ['Uniqname' => $uniqname, 'App' => $a pp]]); 7. 查询模板详情 调用示例 use Ksyun\Service\Ket; $app = 'live'; // 频道名 $uniqname = 'test'; // 用户名 $preset = 'preset_demo'; // 模板名 $response = Ket::getInstance()->request('GetPresetDetail', ['query' => ['Uniqname' => $uniqname, 'App' => $app, 'Preset' => $preset]]); 8. 获取任务列表 调用示例 金山云 25/51

26 use Ksyun\Service\Ket; $app = 'live'; // 频道名 $uniqname = 'test'; // 用户名 $response = Ket::getInstance()->request('GetStreamTranList', ['query' => ['Uniqname' => $uniqname, 'App' = > $app]]); 9. 发起外网拉流 调用示例 use Ksyun\Service\Ket; $app = 'live'; // 频道名 $uniqname = 'test'; // 用户名 $streamid = 'stream '; // 流名 $outpull_data = [ 'App' => $app, 'StreamID' => $streamid, 'SrcUrl' => 'rtmp://test.rtmplive.ks-cdn.com/live/streamdemo', 'Params' => '' ]; $response = Ket::getInstance()->request('StartStreamPull', ['query' => ['Uniqname' => $uniqname], 'json' = > $outpull_data ]); 10. 停止外网拉流 调用示例 金山云 26/51

27 use Ksyun\Service\Ket; $app = 'live'; // 频道名 $uniqname = 'test'; // 用户名 $streamid = 'stream '; // 流名 $response = Ket::getInstance()->request('StopStreamPull', ['query' => ['Uniqname' => $uniqname], 'json' => ['App' => $app, 'StreamID' => $streamid]]); 11. 发起轮播 调用示例 金山云 27/51

28 use Ksyun\Service\Ket; $app = 'live'; // 频道名 $preset = 'preset_demo'; // 模板名 $uniqname = 'test'; // 用户名 $streamid = 'stream '; // 流名 $loop_data = [ 'App' => $app, 'Preset' => $preset, 'StreamID' => $streamid, 'PubDomain' => 'test.uplive.ksyun.com', 'DurationHour' => 168, 'SrcInfo' => array( array( 'Path' => ' 'Index' => 0, ) ) ]; $response = Ket::getInstance()->request('StartLoop', ['query' => ['UniqName' => $uniqname], 'json' => $loo p_data]); 12. 停止轮播 调用示例 金山云 28/51

29 use Ksyun\Service\Ket; $app = 'live'; // 频道名 $uniqname = 'test'; // 用户名 $streamid = 'stream '; // 流名 $response = Ket::getInstance()->request('StopLoop', ['query' => ['UniqName' => $uniqname], 'json' => ['App ' => $app, 'StreamID' => $streamid]]); 13. 更新轮播时长 调用示例 use Ksyun\Service\Ket; $app = 'live'; // 频道名 $uniqname = 'test'; // 用户名 $streamid = 'stream '; // 流名 $response = Ket::getInstance()->request('UpdateLoop', ['query' => ['UniqName' => $uniqname], 'json' => ['A pp' => $app, 'StreamID' => $streamid, 'DurationHour' => 168]]); 14. 获取轮播列表 调用示例 use Ksyun\Service\Ket; $app = 'live'; // 频道名 $uniqname = 'test'; // 用户名 $response = Ket::getInstance()->request('GetLoopList', ['query' => ['UniqName' => $uniqname, 'App' => $app ]]); 金山云 29/51

30 15. 获取配额使用数据 调用示例 use Ksyun\Service\Ket; $uniqname = 'test'; // 用户名 $response = Ket::getInstance()->request('GetQuotaUsed', ['query' => ['Uniqname' => $uniqname]]); 安装 python sdk 1.git 安装 git clone cd ksc-sdk-python python setup.py install 2.pip 安装 pip install ksc-sdk-python 3. 通过文件配置及管理密钥 所在位置 : '/etc/kscore.cfg' 或 './.kscore.cfg' 注意 : 使用相对路径时, 需与运行目录保持一致 ks_access_key_id 和 ks_secret_access_key 是金山云控制台身份与管理里面生成密钥对 [Credentials] ks_access_key_id='xxxxxxxxxxxxxxxxxxxx' ks_secret_access_key='xxxxxxxxxxxxxxxxxxxxxxx' 4. 创建一个 session ( 初始化 ) 金山云 30/51

31 from kscore.ket import getketclient 第一种 : client = getketclient("ket", "cn-beijing-6",use_ssl=false) 参数说明 : service_name: region_name: use_ssl: 服务名, 填写 "ket" 区域名, 填写 "cn-beijing-6" 是否 https 访问, 填写 False 第二种 : 没有配置 kscore.cfg ks_access_key_id='xxxxxxxxxxxxxxxxxxxx' ks_secret_access_key='xxxxxxxxxxxxxxxxxxxxxxx' 参数 : 服务 service_name, 大区 region_name client = getketclient("ket", "cn-beijing-6",use_ssl=false,ks_access_key_id=ks_access_key_id,ks_secret_acce ss_key=ks_secret_access_key) 6. 运行环境 适用于 的 Python 版本 SDK 介绍和使用 接口目录说明 Preset 创建模板 DelPreset 删除模板 GetPresetList 查询模板列表 GetPresetDetail 查询模板详情 GetStreamTranList 获取任务列表 StartStreamPull 发起外网拉流 StopStreamPull 停止外网拉流 StartLoop 发起轮播 StopLoop 停止轮播 UpdateLoop 更新轮播时长 GetLoopList 获取轮播列表 金山云 31/51

32 GetQuotaUsed 获取配额使用数据 CreateDirectorTask 创建选流任务 UpdateDirectorTask 更新选流任务 QueryDirectorTask 查询选流任务 DelDirectorTask 删除选流任务 注 : 接口的传递的参数及返回值请参考 视频云直播转码接入说明 API 接口说明 1. 创建和更新模板 : Preset/UpdatePreset 金山云 32/51

33 presetparam = { "UniqName":"test", "Preset":presetname, "App":app, "Description":description, "Output":[ { "format":{ "output_format":256, "abr": 70000, "vbr": , "fr": 23, { "format":{ "output_format":257 ] 注 : 1.presetParam 必须是 json 格式数据 res = client.preset(presetparam) 2. 删除模板 : DelPreset res = client.delpreset(app="live",uniqname="test",preset=presetname) 3. 查询模板列表 金山云 33/51

34 : GetPresetList res = client.getpresetlist(app="live",uniqname="test") 4. 查询模板详情 : GetPresetDetail res = client.getpresetdetail(app="live",uniqname="test",preset=presetname) 5. 获取任务列表 : GetStreamTranList res = client.getstreamtranlist(app="live",uniqname="test",streamid="test",outpull=-1) 6. 发起外网拉流 : StartStreamPull StartStreamPullParam = { "UniqName":"test", "App":"live", "StreamID":"testName", "SrcUrl":"test.uplive.ks-cdn.com" 注 : 1.StartStreamPullParam 必须是 json 格式数据 res = client.startstreampull(startstreampullparam) 7. 停止外网拉流 : StopStreamPull 金山云 34/51

35 StopStreamPullParam = { "UniqName":"test", "App":"live", "StreamID":"testName" 注 : 1.StopStreamPullParam 必须是 json 格式数据 res = client.stopstreampull(stopstreampullparam) 8. 发起轮播 : StartLoop StartLoopParam = { "UniqName": "test", "App": "live", "StreamID": "testname", "Preset": "1080", "PubDomain": "test.uplive.ksyun.com", "DurationHour":168, "SrcInfo": [ { "Path": " "Index": 0 ] 注 : 1.StartLoopParam 必须是 json 格式数据 res = client.startloop(startloopparam) 9. 停止轮播 : StopLoop 金山云 35/51

36 StopLoopParam = { "UniqName": "test", "App": "live", "StreamID": "testname" 注 : 1.StopLoopParam 必须是 json 格式数据 res = client.stoploop(stoploopparam) 10. 更新轮播时长 : UpdateLoop UpdateLoopParam = { "UniqName": "test", "App": "live", "StreamID": "testname", "DurationHour":100, 注 : 1.UpdateLoopParam 必须是 json 格式数据 res = client.updateloop(updateloopparam) 11. 查询轮播列表 : GetLoopList res = client.getlooplist(app=appname, UniqName=uniqname, StreamID=streamid) 12. 获取配额使用数据 : GetQuotaUsed res = client.getquotaused(uniqname="test") 13. 创建选流任务 金山云 36/51

37 :CreateDirectorTask 金山云 37/51

38 param4 = { "UniqName": uniqname, "App": appname, "Preset": presetname, "SrcInfo": [ { "Url": "rtmp://host/app/outernetstreamforswitch", "Idx": 0, { "Streamid": "streamforswitch", "Idx": 1 ], "DstInfo": [ { "Streamid":"stream0ForMonitor", "Idx": 0, { "Streamid": "stream1forswitch", "Idx": 1, { "Streamid": "stream2forswitch", "Idx": 2 ] res = client.createdirectortask(param4) print json.dumps(res) 金山云 38/51

39 14. 更新选流任务 :UpdateDirectorTask param4["taskid"] = taskid res = client.updatedirectortask(param4) print json.dumps(res) 15. 查询选流任务 :QueryDirectorTask res = client.querydirectortask(app=appname, UniqName=uniqname, TaskID=taskid) print json.dumps(res) 16. 删除选流任务 :DelDirectorTask res = client.deldirectortask(app=appname, UniqName=uniqname, TaskID=taskid) print json.dumps(res) 安装 ja va sdk 1.git 安装 git clone mvn clean install 2.m vn 中央仓库安装 设置 pom 文件即可 3. 工程使用 sdk 录 建议使用 Ma ven 构建自己的项目, 导入 ksc-sdk-ja va, 添加 ksc-sdk-ja va -ket 的依赖 新建 ma ven 项目 进入到 po m 文件下, 进行如下配置 金山云 39/51

40 <dependencies> <dependency> <groupid>com.ksyun</groupid> <artifactid>ksc-sdk-java-ket</artifactid> <version>1.0.4</version> </dependency> </dependencies> 4. 通过文件配置及管理密钥 本地文件配置 : ~/.aws/credentials on Linux, OS X or unix C:\Users\USERNAME\.aws\credentials on Windows 该文件包含下述内容 : [default] aws_access_key_id = your_access_key_id aws_secret_access_key = your_secret_access_key 如不通过本地文件读入 a k 和 sk 信息, 则需要在执行的类文件中增加以下代码 : AWSCredentials credentials = new BasicAWSCredentials(aws_access_key_id, aws_secret_access_key); SDK 介绍和使用 在调用接口前, 先初始化 KS C O FFJso nc lient, 如下用例 : KSCKETJsonClient ksc = new KSCKETJsonClient(); // 可传入 AWSCredentials 参数如 :KSCKETJsonClient ksc = new KSCKETJsonClient(credentials); ksc.setendpoint(" 字符集 :utf-8 SDK 介绍和使用 接口目录说明 Preset 创建和更新模板 金山云 40/51

41 DelPreset 删除模板 GetPresetList 查询模板列表 GetPresetDetail 查询模板详情 GetStreamTranList 获取任务列表 StartStreamPull 发起外网拉流 StopStreamPull 停止外网拉流 StartLoop 发起轮播 StopLoop 停止轮播 UpdateLoop 更新轮播时长 GetLoopList 获取轮播列表 GetQuotaUsed 获取配额使用数据 CreateDirectorTask 创建选流任务 UpdateDirectorTask 更新选流任务 QueryDirectorTask 查询选流任务 DelDirectorTask 删除选流任务 注 : 接口的传递的参数及返回值请参考 视频云直播转码接入说明 API 接口说明 1. 创建和更新模板 : Preset 和 UpdatePreset PresetRequest presetrequest = new PresetRequest(); String data = PresetSet("preset", 2); presetrequest.setdata(data); ErrResult presetresult = ksc.preset(presetrequest); System.out.println("ErrNum: " + presetresult.geterrnum() + ",ErrMsg: " + presetresult.geterrmsg()); // 请求内容生成接口 private static String PresetSet(String preset, int num) throws JSONException { int formatset[] = new int[] { 256, 257, 258, 259 ; JSONObject data = new JSONObject(); JSONArray output = new JSONArray(); JSONArray logo = new JSONArray(); 金山云 41/51

42 JSONArray logo = new JSONArray(); JSONObject video = new JSONObject(); data.put("uniqname", "mytest"); data.put("preset", preset); data.put("description", "desc:" + preset); data.put("app", "live"); for (int i = 0; i < num; i++) { JSONObject output_tmp = new JSONObject(); JSONObject format = new JSONObject(); JSONObject _switch = new JSONObject(); format.put("output_format", formatset[i]); format.put("vbr", ); _switch.put("sn", 0); _switch.put("sm", 0); _switch.put("hv", 0); output_tmp.put("format", format); output_tmp.put("switch", _switch); output.put(output_tmp); data.put("output", output); video.put("orientationadapt", 1); for (int i = 0; i < num; i++) { JSONObject logo_tmp = new JSONObject(); logo_tmp.put("pic", "/wangshuai9/1.png"); logo_tmp.put("short_side", 640); logo.put(logo_tmp); video.put("logo", logo); data.put("video", video); return data.tostring(); 金山云 42/51

43 2. 删除模板 : DelPreset DelPresetRequest delpresetrequest = new DelPresetRequest(); delpresetrequest.setapp("live"); delpresetrequest.setuniqname("mytest"); delpresetrequest.setpreset("preset"); ErrResult delpresetresult = ksc.delpreset(delpresetrequest); System.out.println("ErrNum: " + delpresetresult.geterrnum() + ",ErrMsg: " + delpresetresult.geterrmsg()); 3. 查询模板列表 : GetPresetList GetPresetListRequest getpresetlistrequest = new GetPresetListRequest(); getpresetlistrequest.setapp("live"); getpresetlistrequest.setuniqname("mytest"); GetPresetListResult getpresetlistresult = ksc.getpresetlist(getpresetlistrequest); 4. 查询模板详情 : GetPresetDetail GetPresetDetailRequest getpresetdetailrequest = new GetPresetDetailRequest(); getpresetdetailrequest.setapp("live"); getpresetdetailrequest.setuniqname("mytest"); getpresetdetailrequest.setpreset("preset"); GetPresetDetailResult getpresetdetailresult = ksc.getpresetdetail(getpresetdetailrequest); 5. 获取任务列表 : GetStreamTranList 金山云 43/51

44 GetStreamTranListRequest getstreamtranlistrequest = new GetStreamTranListRequest(); getstreamtranlistrequest.setapp("live"); getstreamtranlistrequest.setuniqname("mytest"); GetStreamTranListResult getstreamtranlistresult = ksc.getstreamtranlist(getstreamtranlistrequest); 6. 发起外网拉流 : StartStreamPull StartStreamPullRequest startstreampullrequest = new StartStreamPullRequest(); String data1 = StreamPullSet("test123"); startstreampullrequest.setdata(data1); ErrResult startstreampullresult = ksc.startstreampull(startstreampullrequest); System.out.println("ErrNum: " + startstreampullresult.geterrnum() + ",ErrMsg: " + startstreampullresult.ge terrmsg()); // 请求内容接口 private static String StreamPullSet(String StreamID) { JSONObject data = new JSONObject(); data.put("uniqname", "mytest"); data.put("streamid", StreamID); if (type == 0) { data.put("srcurl", "test.uplive.ks-cdn.com"); data.put("app", "live"); return data.tostring(); 7. 停止外网拉流 : StopStreamPull 金山云 44/51

45 StopStreamPullRequest stopstreampullrequest = new StopStreamPullRequest(); String data2 = StreamPullSet("test123"); stopstreampullrequest.setdata(data2); ErrResult stopstreampullresult = ksc.stopstreampull(stopstreampullrequest); System.out.println("ErrNum: " + stopstreampullresult.geterrnum() + ",ErrMsg: " + stopstreampullresult.gete rrmsg()); // 请求内容接口 private static String StreamPullSet(String StreamID) { JSONObject data = new JSONObject(); data.put("uniqname", "mytest"); data.put("streamid", StreamID); if (type == 0) { data.put("srcurl", "test.uplive.ks-cdn.com"); data.put("app", "live"); return data.tostring(); 8. 发起轮播 : StartLoop 金山云 45/51

46 StartLoopRequest startlooprequest = new StartLoopRequest(); String startloopdata = StartLoopSet(); startlooprequest.setdata(startloopdata); StartLoopResult startloopresult = ksc.startloop(startlooprequest); System.out.println(startLoopResult.getList().get(0).getTaskID()); // 请求内容接口 private static String StartLoopSet() { JSONObject data = new JSONObject(); JSONArray srcinfo = new JSONArray(); data.put("pubdomain", "videoqa.uplive.ks-cdn.com"); data.put("uniqname", UniqName); data.put("preset", "looppreset"); data.put("streamid", "java_sdk_1234"); data.put("app", "live"); data.put("durationhour", 168); JSONObject tmp = new JSONObject(); tmp.put("path", " v.mkv"); tmp.put("index", 0); srcinfo.put(tmp); data.put("srcinfo", srcinfo); return data.tostring(); 9. 停止轮播 : StopLoop 金山云 46/51

47 StopLoopRequest stoplooprequest = new StopLoopRequest(); String stoploopdata = StopLoopSet(); stoplooprequest.setdata(stoploopdata); ErrResult stoploopresult = ksc.stoploop(stoplooprequest); // 请求内容接口 private static String StopLoopSet() { JSONObject data = new JSONObject(); data.put("app", "live"); data.put("uniqname", UniqName); data.put("streamid", "java_sdk_1234"); return data.tostring(); 10. 更新轮播时长 : UpdateLoop UpdateLoopRequest updatelooprequest = new UpdateLoopRequest(); String updateloopdata = UpdateLoopSet(); updatelooprequest.setdata(updateloopdata); ErrResult updateloop = ksc.updateloop(updatelooprequest); System.out.println(updateLoop.getErrMsg()); // 请求内容接口 private static String UpdateLoopSet() { JSONObject data = new JSONObject(); data.put("app", "live"); data.put("uniqname", UniqName); data.put("streamid", "java_sdk_1234"); data.put("durationhour", 10); return data.tostring(); 金山云 47/51

48 11. 获取轮播列表 : GetLoopList GetLoopListRequest getlooplistrequest = new GetLoopListRequest(); getlooplistrequest.setapp("live"); getlooplistrequest.setuniqname(uniqname); GetLoopListResult getlooplistresult = ksc.getlooplist(getlooplistrequest); System.out.println(getLoopListResult.getList().get(0).getTaskID()); 12. 获取配额使用数据 : GetQuotaUsed GetQuotaUsedRequest getquotausedrequest = new GetQuotaUsedRequest(); getquotausedrequest.setuniqname(uniqname); GetQuotaUsedResult getquotausedresult = ksc.getquotaused(getquotausedrequest); System.out.println("ErrNum: " + getquotausedresult.geterrnum() + ",ErrMsg: " + getquotausedresult.geterrms g()); 13. 创建选流任务 :CreateDirectorTask 金山云 48/51

49 CreateDirectorTaskRequest createdirectortaskrequest = new CreateDirectorTaskRequest(); createdirectortaskrequest.setdata(directortaskset()); ErrResult createdirectortaskresult = ksc.createdirectortask(createdirectortaskrequest); System.out.println(createDirectorTaskResult.getTaskID()); private static String DirectorTaskSet(){ JSONObject data = new JSONObject(); data.put("app", "live"); data.put("uniqname", UniqName); JSONArray SrcInfo = new JSONArray(); for (int i = 0; i < 2; i++) { JSONObject info = new JSONObject(); info.put("srcurl","rtmp://host/app/outernetstreamforswitch"); info.put("index",i); SrcInfo.put(info); data.put("srcinfo", SrcInfo); return data.tostring(); 14. 更新选流任务 :UpdateDirectorTask 金山云 49/51

50 UpdateDirectorTaskRequest updatedirectortaskrequest = new UpdateDirectorTaskRequest(); updatedirectortaskrequest.setdata(directortaskset()); ErrResult updatedirectortaskresult = ksc.updatedirectortask(updatedirectortaskrequest); System.out.println(updateDirectorTaskResult.getErrNum()); private static String DirectorTaskSet(){ JSONObject data = new JSONObject(); data.put("app", "live"); data.put("uniqname", UniqName); JSONArray SrcInfo = new JSONArray(); for (int i = 0; i < 2; i++) { JSONObject info = new JSONObject(); info.put("srcurl","rtmp://host/app/outernetstreamforswitch"); info.put("index",i); SrcInfo.put(info); data.put("srcinfo", SrcInfo); return data.tostring(); 15. 查询选流任务 :QueryDirectorTask QueryDirectorTaskRequest querydirectortaskrequest = new QueryDirectorTaskRequest(); querydirectortaskrequest.setapp("live"); querydirectortaskrequest.setuniqname(uniqname); QueryDirectorTaskResult querydirectortaskresult = ksc.querydirectortask(querydirectortaskrequest); System.out.println(queryDirectorTaskResult.getErrNum()); 16. 删除选流任务 :DelDirectorTask 金山云 50/51

51 DelDirectorTaskRequest deldirectortaskrequest = new DelDirectorTaskRequest(); deldirectortaskrequest.setapp("live"); deldirectortaskrequest.setuniqname(uniqname); ErrResult deldirectortaskresult = ksc.deldirectortask(deldirectortaskrequest); System.out.println(delDirectorTaskResult.getErrNum()); 金山云 51/51