iOS API client

badgebadge   badgebadge   badgebadge

api.video iOS 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.

Table of contents

Project description

api.video's iOS client 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-ios-client" ~> 1.0.0

Run carthage update

CocoaPods

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

Run pod install

Code sample

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

import ApiVideoClient

    ApiVideoClient.apiKey = "YOUR_API_TOKEN"
    // 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 {
        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
            }
        }
    }
    if let error = error {
       // Manage create error here
    }
}

Documentation

API Endpoints

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

CaptionsAPI

Retrieve an instance of CaptionsAPI:

CaptionsAPI

Endpoints

MethodHTTP requestDescription
deleteDELETE /videos/{videoId}/captions/{language}Delete a caption
listGET /videos/{videoId}/captionsList video captions
getGET /videos/{videoId}/captions/{language}Show a caption
updatePATCH /videos/{videoId}/captions/{language}Update caption
uploadPOST /videos/{videoId}/captions/{language}Upload a caption

ChaptersAPI

Retrieve an instance of ChaptersAPI:

ChaptersAPI

Endpoints

MethodHTTP requestDescription
deleteDELETE /videos/{videoId}/chapters/{language}Delete a chapter
listGET /videos/{videoId}/chaptersList video chapters
getGET /videos/{videoId}/chapters/{language}Show a chapter
uploadPOST /videos/{videoId}/chapters/{language}Upload a chapter

LiveStreamsAPI

Retrieve an instance of LiveStreamsAPI:

LiveStreamsAPI

Endpoints

MethodHTTP requestDescription
deleteDELETE /live-streams/{liveStreamId}Delete a live stream
deleteThumbnailDELETE /live-streams/{liveStreamId}/thumbnailDelete a thumbnail
listGET /live-streamsList all live streams
getGET /live-streams/{liveStreamId}Show live stream
updatePATCH /live-streams/{liveStreamId}Update a live stream
createPOST /live-streamsCreate live stream
uploadThumbnailPOST /live-streams/{liveStreamId}/thumbnailUpload a thumbnail

PlayerThemesAPI

Retrieve an instance of PlayerThemesAPI:

PlayerThemesAPI

Endpoints

MethodHTTP requestDescription
deleteDELETE /players/{playerId}Delete a player
deleteLogoDELETE /players/{playerId}/logoDelete logo
listGET /playersList all player themes
getGET /players/{playerId}Show a player
updatePATCH /players/{playerId}Update a player
createPOST /playersCreate a player
uploadLogoPOST /players/{playerId}/logoUpload a logo

RawStatisticsAPI

Retrieve an instance of RawStatisticsAPI:

RawStatisticsAPI

Endpoints

MethodHTTP requestDescription
listLiveStreamSessionsGET /analytics/live-streams/{liveStreamId}List live stream player sessions
listSessionEventsGET /analytics/sessions/{sessionId}/eventsList player session events
listVideoSessionsGET /analytics/videos/{videoId}List video player sessions

UploadTokensAPI

Retrieve an instance of UploadTokensAPI:

UploadTokensAPI

Endpoints

MethodHTTP requestDescription
deleteTokenDELETE /upload-tokens/{uploadToken}Delete an upload token
listGET /upload-tokensList all active upload tokens.
getTokenGET /upload-tokens/{uploadToken}Show upload token
createTokenPOST /upload-tokensGenerate an upload token

VideosAPI

Retrieve an instance of VideosAPI:

VideosAPI

Endpoints

MethodHTTP requestDescription
deleteDELETE /videos/{videoId}Delete a video
getGET /videos/{videoId}Show a video
getStatusGET /videos/{videoId}/statusShow video status
listGET /videosList all videos
updatePATCH /videos/{videoId}Update a video
pickThumbnailPATCH /videos/{videoId}/thumbnailPick a thumbnail
uploadWithUploadTokenPOST /uploadUpload with an upload token
createPOST /videosCreate a video
uploadPOST /videos/{videoId}/sourceUpload a video
uploadThumbnailPOST /videos/{videoId}/thumbnailUpload a thumbnail

WatermarksAPI

Retrieve an instance of WatermarksAPI:

WatermarksAPI

Endpoints

MethodHTTP requestDescription
deleteDELETE /watermarks/{watermarkId}Delete a watermark
listGET /watermarksList all watermarks
uploadPOST /watermarksUpload a watermark

WebhooksAPI

Retrieve an instance of WebhooksAPI:

WebhooksAPI

Endpoints

MethodHTTP requestDescription
deleteDELETE /webhooks/{webhookId}Delete a Webhook
getGET /webhooks/{webhookId}Show Webhook details
listGET /webhooksList all webhooks
createPOST /webhooksCreate Webhook

Models

Documentation for Authorization

API token

Most endpoints required to be authenticated using the API token mechanism described in our documentation.
The access token generation mechanism is automatically handled by the client. All you have to do is provide an API token:

ApiVideoClient.apiKey = YOUR_API_TOKEN

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.


Did this page help you?