全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

SDK for Python 使用指南

最近更新时间:2022-02-18 17:45:48

安装python sdk

1.git 安装

git clone https://github.com/KscSDK/ksc-sdk-python.git

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 (初始化)

from kscore.ket import getKetClient

第一种:

client = getKetClient("ket", "cn‐beijing‐6",use_ssl=False)

参数说明:

	service_name:	服务名,填写"ket"

	region_name:	区域名,填写"cn‐beijing‐6"

	use_ssl:		是否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_access_key=ks_secret_access_key)

5.运行环境

适用于2.6、2.7、3.3、3.4的Python版本

SDK介绍和使用

接口目录说明

注:接口的传递的参数及返回值请参考《视频云直播转码接入说明》API接口说明

1.创建和更新模板

  • 接口名: Preset/UpdatePreset
  • 调用方式
presetParam = {

    "UniqName":"test",

    "Preset":presetname,

    "App":app,

    "Description":description,

    "Output":[

        {

            "format":{

                "output_format":256,

                "abr": 70000,

                "vbr": 700000,

                "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.查询模板列表

  • 接口名: 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
  • 调用方式
StopStreamPullParam = {

    "UniqName":"test",

    "App":"live",

    "StreamID":"testName"

}注:

1.StopStreamPullParam必须是json格式数据

res = client.StopStreamPull(StopStreamPullParam)

8.获取配额使用数据

  • 接口名: GetQuotaUsed
  • 调用方式
res = client.GetQuotaUsed(UniqName="test")
文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈