api.video Swift API client

api.video is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app.

Project description

api.video's Swift API client for iOS, macOS and tvOS streamlines the coding process. Chunking files is handled for you, as is pagination and refreshing your tokens.

Getting started

Installation

Carthage

Specify it in your Cartfile:

github "apivideo/api.video-swift-client" ~> 1.2.2

Run carthage update

CocoaPods

Add pod 'ApiVideoClient', '1.2.2' in your Podfile

Run pod install

Code sample

Please follow the installation instruction and execute the following Swift code:

import ApiVideoClient

// If you rather like to use the sandbox environment:
// ApiVideoClient.basePath = Environment.sandbox.rawValue

try VideosAPI.uploadWithUploadToken(token: "MY_VIDEO_TOKEN", file: url) { video, error in
    if let video = video {
        // Manage upload with upload token success here
    }
    if let error = error {
        // Manage upload with upload token error here
    }
}

Documentation

API Endpoints

All URIs are relative to https://ws.api.video

AnalyticsAPI

Retrieve an instance of AnalyticsAPI:
AnalyticsAPI
Endpoints
MethodHTTP requestDescription
getLiveStreamsPlaysGET /analytics/live-streams/playsGet play events for live stream
getVideosPlaysGET /analytics/videos/playsGet play events for video

CaptionsAPI

Retrieve an instance of CaptionsAPI:
CaptionsAPI
Endpoints
MethodHTTP requestDescription
uploadPOST /videos/{videoId}/captions/{language}Upload a caption
getGET /videos/{videoId}/captions/{language}Retrieve a caption
updatePATCH /videos/{videoId}/captions/{language}Update a caption
deleteDELETE /videos/{videoId}/captions/{language}Delete a caption
listGET /videos/{videoId}/captionsList video captions

ChaptersAPI

Retrieve an instance of ChaptersAPI:
ChaptersAPI
Endpoints
MethodHTTP requestDescription
uploadPOST /videos/{videoId}/chapters/{language}Upload a chapter
getGET /videos/{videoId}/chapters/{language}Retrieve a chapter
deleteDELETE /videos/{videoId}/chapters/{language}Delete a chapter
listGET /videos/{videoId}/chaptersList video chapters

LiveStreamsAPI

Retrieve an instance of LiveStreamsAPI:
LiveStreamsAPI
Endpoints
MethodHTTP requestDescription
createPOST /live-streamsCreate live stream
getGET /live-streams/{liveStreamId}Retrieve live stream
updatePATCH /live-streams/{liveStreamId}Update a live stream
deleteDELETE /live-streams/{liveStreamId}Delete a live stream
listGET /live-streamsList all live streams
uploadThumbnailPOST /live-streams/{liveStreamId}/thumbnailUpload a thumbnail
deleteThumbnailDELETE /live-streams/{liveStreamId}/thumbnailDelete a thumbnail

PlayerThemesAPI

Retrieve an instance of PlayerThemesAPI:
PlayerThemesAPI
Endpoints
MethodHTTP requestDescription
createPOST /playersCreate a player
getGET /players/{playerId}Retrieve a player
updatePATCH /players/{playerId}Update a player
deleteDELETE /players/{playerId}Delete a player
listGET /playersList all player themes
uploadLogoPOST /players/{playerId}/logoUpload a logo
deleteLogoDELETE /players/{playerId}/logoDelete logo

UploadTokensAPI

Retrieve an instance of UploadTokensAPI:
UploadTokensAPI
Endpoints
MethodHTTP requestDescription
createTokenPOST /upload-tokensGenerate an upload token
getTokenGET /upload-tokens/{uploadToken}Retrieve upload token
deleteTokenDELETE /upload-tokens/{uploadToken}Delete an upload token
listGET /upload-tokensList all active upload tokens

VideosAPI

Retrieve an instance of VideosAPI:
VideosAPI
Endpoints
MethodHTTP requestDescription
createPOST /videosCreate a video object
uploadPOST /videos/{videoId}/sourceUpload a video
uploadWithUploadTokenPOST /uploadUpload with an delegated upload token
getGET /videos/{videoId}Retrieve a video object
updatePATCH /videos/{videoId}Update a video object
deleteDELETE /videos/{videoId}Delete a video object
listGET /videosList all video objects
uploadThumbnailPOST /videos/{videoId}/thumbnailUpload a thumbnail
pickThumbnailPATCH /videos/{videoId}/thumbnailSet a thumbnail
getStatusGET /videos/{videoId}/statusRetrieve video status and details

WatermarksAPI

Retrieve an instance of WatermarksAPI:
WatermarksAPI
Endpoints
MethodHTTP requestDescription
uploadPOST /watermarksUpload a watermark
deleteDELETE /watermarks/{watermarkId}Delete a watermark
listGET /watermarksList all watermarks

WebhooksAPI

Retrieve an instance of WebhooksAPI:
WebhooksAPI
Endpoints
MethodHTTP requestDescription
createPOST /webhooksCreate Webhook
getGET /webhooks/{webhookId}Retrieve Webhook details
deleteDELETE /webhooks/{webhookId}Delete a Webhook
listGET /webhooksList all webhooks

Models

Documentation for Authorization

API key

Most endpoints required to be authenticated using the API key mechanism described in our documentation.

You must NOT store your API key in your application code to prevent your API key from being exposed in your source code. Only the Public endpoints can be called without authentication. In the case, you want to call an endpoint that requires authentication, you will have to use a backend server. See Security best practices for more details.

Public endpoints

Some endpoints don't require authentication. These one can be called without setting ApiVideoClient.apiKey.

Have you gotten use from this API client?

Please take a moment to leave a star on the client ⭐

This helps other users to find the clients and also helps us understand which clients are most popular. Thank you!

Contribution

Since this API client is generated from an OpenAPI description, we cannot accept pull requests made directly to the repository. If you want to contribute, you can open a pull request on the repository of our client generator. Otherwise, you can also simply open an issue detailing your need on this repository.

Was this page helpful?