ApiVideoClient 1.3.0

ApiVideoClient 1.3.0

×

由 api.video 生态系统团队 维护。

 
依赖项
AnyCodable-FlightSchool~> 0.6.1
Alamofire~> 5.4.3
 

ApiVideoClient 1.3.0

  • 作者：
  • 生态系统团队

badge   badge   badge

api.video iOS 客户端

api.video 是为产品构建者提供视频基础设施。提供闪电般快的视频 API，以集成、扩展和管理应用程序中的即时和低延迟实时流功能。

目录

项目描述

api.video的iOS简化了编码过程。文件分块以及分页和令牌刷新都由系统处理。

入门

安装

Carthage

在您的Cartfile中指定它

github "apivideo/api.video-ios-client" ~> 1.2.1

运行carthage update

CocoaPods

在您的 Podfile 中添加 pod 'ApiVideoClient', '1.2.1'

运行 pod install

代码示例

请按照安装说明进行操作，并执行以下Swift代码

import ApiVideoClient

    ApiVideoClient.apiKey = "YOUR_API_KEY"
    // if you rather like to use the sandbox environment:
    // ApiVideoClient.basePath = Environment.sandbox.rawValue

    let url = URL(string: "My video.mov")

    VideosAPI.create(videoCreationPayload: VideoCreationPayload(title: "my video")) { video, error in
    if let video = video {
        do {
            try VideosAPI.upload(videoId: video.videoId,
                             file: url) { video, error in
                if let video = video {
                    // Manage upload success here
                }
                if let error = error {
                    // Manage upload error here
                }
            }
        } catch {
            // Manage error on file here
        }
    }
    if let error = error {
       // Manage create error here
    }
}

文档

API端点

所有URI均相对于 https://ws.api.video

AnalyticsAPI

获取AnalyticsAPI实例

AnalyticsAPI

端点

方法 HTTP请求 描述
getLiveStreamsPlays GET /analytics/live-streams/plays 获取直播流播放事件
getVideosPlays GET /analytics/videos/plays 获取视频播放事件

CaptionsAPI

获取CaptionsAPI实例

CaptionsAPI

端点

方法 HTTP请求 描述
上传 POST /videos/{videoId}/captions/{language} 上传字幕
获取 GET /videos/{videoId}/captions/{language} 检索字幕
更新 PATCH /videos/{videoId}/captions/{language} 更新字幕
删除 DELETE /videos/{videoId}/captions/{language} 删除字幕
列表 GET /videos/{videoId}/captions 列出视频字幕

ChaptersAPI

检索ChaptersAPI的一个实例

ChaptersAPI

端点

方法 HTTP请求 描述
上传 POST /videos/{videoId}/chapters/{language} 上传章节
获取 GET /videos/{videoId}/chapters/{language} 检索章节
删除 DELETE /videos/{videoId}/chapters/{language} 删除章节
列表 GET /videos/{videoId}/chapters 列出视频章节

LiveStreamsAPI

获取 LiveStreamsAPI 实例

LiveStreamsAPI

端点

方法 HTTP请求 描述
创建 POST /live-streams 创建直播流
获取 GET /live-streams/{liveStreamId} 检索直播流
更新 PATCH /live-streams/{liveStreamId} 更新直播流
删除 DELETE /live-streams/{liveStreamId} 删除直播流
列表 GET /live-streams 列出所有直播流
uploadThumbnail POST /live-streams/{liveStreamId}/thumbnail 上传缩略图
deleteThumbnail DELETE /live-streams/{liveStreamId}/thumbnail 删除缩略图

PlayerThemesAPI

获取 PlayerThemesAPI 实例

PlayerThemesAPI

端点

方法 HTTP请求 描述
创建 POST /players 创建玩家
获取 GET /players/{playerId} 检索玩家
更新 PATCH /players/{playerId} 更新玩家
删除 DELETE /players/{playerId} 删除玩家
列表 GET /players 列出所有玩家主题
uploadLogo POST /players/{playerId}/logo 上传徽标
deleteLogo DELETE /players/{playerId}/logo 删除徽标

RawStatisticsAPI

检索RawStatisticsAPI的一个实例

RawStatisticsAPI

端点

方法 HTTP请求 描述
listLiveStreamSessions GET /analytics/live-streams/{liveStreamId} 列出直播流玩家会话
listSessionEvents GET /analytics/sessions/{sessionId}/events 列出玩家会话事件
listVideoSessions GET /analytics/videos/{videoId} 列出视频玩家会话

UploadTokensAPI

检索 UploadTokensAPI 实例

UploadTokensAPI

端点

方法 HTTP请求 描述
createToken POST /upload-tokens 生成上传令牌
getToken GET /upload-tokens/{uploadToken} 检索上传令牌
deleteToken DELETE /upload-tokens/{uploadToken} 删除上传令牌
列表 GET /upload-tokens 列出所有活跃的上传令牌

VideosAPI

检索 VideosAPI 实例

VideosAPI

端点

方法 HTTP请求 描述
创建 POST /videos 创建视频对象
上传 POST /videos/{videoId}/source 上传视频
uploadWithUploadToken POST /upload 使用委派上传令牌上传
获取 GET /videos/{videoId} 检索视频对象
更新 PATCH /videos/{videoId} 更新视频对象
删除 DELETE /videos/{videoId} 删除视频对象
列表 GET /videos 列出所有视频对象
uploadThumbnail POST /videos/{videoId}/thumbnail 上传缩略图
选择缩略图 PATCH /videos/{videoId}/thumbnail 设置缩略图
getStatus GET /videos/{videoId}/status 检索视频状态和详细信息

WatermarksAPI

检索 WatermarksAPI 的实例

WatermarksAPI

端点

方法 HTTP请求 描述
上传 POST /watermarks 上传水印
删除 DELETE /watermarks/{watermarkId} 删除水印
列表 GET /watermarks 列出所有水印

WebhooksAPI

检索WebhooksAPI的实例

WebhooksAPI

端点

方法 HTTP请求 描述
创建 POST /webhooks 创建Webhook
获取 GET /webhooks/{webhookId} 检索Webhook详细信息
删除 DELETE /webhooks/{webhookId} 删除Webhook
列表 GET /webhooks 列出所有Webhook

模型

授权说明

API密钥

大多数端点需要使用我们文档中描述的API密钥机制进行认证。访问令牌的生成机制会由客户端自动处理。您只需提供一个API密钥即可。

ApiVideoClient.apiKey = YOUR_API_KEY

公开端点

有些端点不需要认证。这些端点可以调用，无需设置ApiVideoClient.apiKey

您从此API客户端中得到了什么帮助吗？

请花点时间给客户端点一个星⭐

这有助于其他用户找到这些客户端，也有助于我们了解哪些客户端最受欢迎。谢谢！

贡献

由于此API客户端是从OpenAPI描述生成的，我们不能接受直接发送到存储库的拉取请求。如果您想贡献，您可以在我们客户端生成器的存储库上发起拉取请求。否则，您也可以简单地在这个存储库上打开一个问题描述您的需求。