github.com/qiniu/go-sdk/v7@v7.27.0/pili/doc.go (about)

     1  // Package pili 提供七牛云直播服务（Pili）的 Go 客户端。
     2  //
     3  // 官方文档: https://developer.qiniu.com/pili
     4  //
     5  // # 创建客户端
     6  //
     7  //	manager := pili.NewManager(pili.ManagerConfig{
     8  //	    AccessKey: "AK",
     9  //	    SecretKey: "SK",
    10  //	})
    11  //
    12  // # 直播空间管理
    13  //
    14  //   - [Manager.GetHubList] / [Manager.GetHubInfo]: 查询直播空间
    15  //   - [Manager.HubSecurity] / [Manager.HubHlsplus] / [Manager.HubPersistence] / [Manager.HubSnapshot]: 空间配置
    16  //
    17  // # 流管理
    18  //
    19  //   - [Manager.GetStreamsList] / [Manager.GetStreamBaseInfo]: 查询流信息
    20  //   - [Manager.GetStreamLiveStatus] / [Manager.BatchGetStreamLiveStatus]: 查询直播状态
    21  //   - [Manager.StreamDisable]: 禁用/启用流
    22  //   - [Manager.StreamSaveas]: 录制保存
    23  //   - [Manager.StreamSnapshot]: 截图
    24  //   - [Manager.GetStreamHistory]: 推流历史
    25  //
    26  // # 域名管理
    27  //
    28  //   - [Manager.GetDomainsList] / [Manager.GetDomainInfo]: 查询域名
    29  //   - [Manager.BindDomain] / [Manager.UnbindDomain]: 绑定/解绑域名
    30  //   - [Manager.SetDomainCert] / [Manager.SetDomainURLRewrite]: 域名配置
    31  //
    32  // # 推拉流地址生成
    33  //
    34  // 提供包级函数生成推拉流地址：
    35  //
    36  //	rtmpPushURL := pili.RTMPPublishURL("hub", "domain", "streamTitle")
    37  //	hlsPlayURL := pili.HLSPlayURL("hub", "domain", "streamTitle")
    38  //	signedURL, _ := pili.SignPublishURL(rtmpPushURL, pili.SignPublishURLArgs{...})
    39  //
    40  // 支持的协议: [RTMPPublishURL]、[SRTPublishURL]、[RTMPPlayURL]、[HLSPlayURL]、[HDLPlayURL]。
    41  //
    42  // # 数据统计
    43  //
    44  //   - [Manager.GetStatUpflow] / [Manager.GetStatDownflow]: 上下行流量统计
    45  //   - [Manager.GetStatCodec] / [Manager.GetStatNrop] / [Manager.GetStatPub]: 编码、断流、推流统计
    46  package pili