The official iOS client library for api.video

Last update: Dec 2, 2022

Overview

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.

Project description
Getting started
- Installation
  - Carthage
  - CocoaPods
- Code sample
Documentation
Have you gotten use from this API client?
Contribution

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" ~> 0.1.2

Run carthage update

CocoaPods

Add pod 'ApiVideoClient', '0.1.2' 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

Method	HTTP request	Description
delete	DELETE /videos/{videoId}/captions/{language}	Delete a caption
list	GET /videos/{videoId}/captions	List video captions
get	GET /videos/{videoId}/captions/{language}	Show a caption
update	PATCH /videos/{videoId}/captions/{language}	Update caption
upload	POST /videos/{videoId}/captions/{language}	Upload a caption

ChaptersAPI

Retrieve an instance of ChaptersAPI:

ChaptersAPI

Endpoints

Method	HTTP request	Description
delete	DELETE /videos/{videoId}/chapters/{language}	Delete a chapter
list	GET /videos/{videoId}/chapters	List video chapters
get	GET /videos/{videoId}/chapters/{language}	Show a chapter
upload	POST /videos/{videoId}/chapters/{language}	Upload a chapter

LiveStreamsAPI

Retrieve an instance of LiveStreamsAPI:

LiveStreamsAPI

Endpoints

Method	HTTP request	Description
delete	DELETE /live-streams/{liveStreamId}	Delete a live stream
deleteThumbnail	DELETE /live-streams/{liveStreamId}/thumbnail	Delete a thumbnail
list	GET /live-streams	List all live streams
get	GET /live-streams/{liveStreamId}	Show live stream
update	PATCH /live-streams/{liveStreamId}	Update a live stream
create	POST /live-streams	Create live stream
uploadThumbnail	POST /live-streams/{liveStreamId}/thumbnail	Upload a thumbnail

PlayerThemesAPI

Retrieve an instance of PlayerThemesAPI:

PlayerThemesAPI

Endpoints

Method	HTTP request	Description
delete	DELETE /players/{playerId}	Delete a player
deleteLogo	DELETE /players/{playerId}/logo	Delete logo
list	GET /players	List all player themes
get	GET /players/{playerId}	Show a player
update	PATCH /players/{playerId}	Update a player
create	POST /players	Create a player
uploadLogo	POST /players/{playerId}/logo	Upload a logo

RawStatisticsAPI

Retrieve an instance of RawStatisticsAPI:

RawStatisticsAPI

Endpoints

Method	HTTP request	Description
listLiveStreamSessions	GET /analytics/live-streams/{liveStreamId}	List live stream player sessions
listSessionEvents	GET /analytics/sessions/{sessionId}/events	List player session events
listVideoSessions	GET /analytics/videos/{videoId}	List video player sessions

UploadTokensAPI

Retrieve an instance of UploadTokensAPI:

UploadTokensAPI

Endpoints

Method	HTTP request	Description
deleteToken	DELETE /upload-tokens/{uploadToken}	Delete an upload token
list	GET /upload-tokens	List all active upload tokens.
getToken	GET /upload-tokens/{uploadToken}	Show upload token
createToken	POST /upload-tokens	Generate an upload token

VideosAPI

Retrieve an instance of VideosAPI:

VideosAPI

Endpoints

Method	HTTP request	Description
delete	DELETE /videos/{videoId}	Delete a video
get	GET /videos/{videoId}	Show a video
getStatus	GET /videos/{videoId}/status	Show video status
list	GET /videos	List all videos
update	PATCH /videos/{videoId}	Update a video
pickThumbnail	PATCH /videos/{videoId}/thumbnail	Pick a thumbnail
uploadWithUploadToken	POST /upload	Upload with an upload token
create	POST /videos	Create a video
upload	POST /videos/{videoId}/source	Upload a video
uploadThumbnail	POST /videos/{videoId}/thumbnail	Upload a thumbnail

WebhooksAPI

Retrieve an instance of WebhooksAPI:

WebhooksAPI

Endpoints

Method	HTTP request	Description
delete	DELETE /webhooks/{webhookId}	Delete a Webhook
get	GET /webhooks/{webhookId}	Show Webhook details
list	GET /webhooks	List all webhooks
create	POST /webhooks	Create 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.

Comments

chore(ios): temporary disable watchos support in cocoapods. Due to Co…

Disable watchos support in cocoapods due to CocoaPods/CocoaPods#11558. Created by @ThibaultBee via https://github.com/apivideo/api.video-api-client-generator/pull/151

opened by bot-api-video 0
Feature/ios task cancellation
iOS client and uploader:

refactor upload part

add possibility to cancel upload tasks

add timeout API

Created by @ThibaultBee via https://github.com/apivideo/api.video-api-client-generator/pull/146
opened by bot-api-video 0
fix(oas): add missing linkActive field in player upload/create payload

Fix player bug - the “Link active color” doesn’t save Created by @ThibaultBee via https://github.com/apivideo/api.video-api-client-generator/pull/111

opened by bot-api-video 0
fix(swift5): Fix progressive upload protocol visibility

fix(swift5): Fix progressive upload protocol visibility Created by @ThibaultBee via https://github.com/apivideo/api.video-api-client-generator/pull/97

opened by bot-api-video 0
feat(swift5): Use a protocol for progressive upload session

feat(swift5): Use a protocol for progressive upload session Created by @ThibaultBee via https://github.com/apivideo/api.video-api-client-generator/pull/96

opened by bot-api-video 0

Releases(v1.1.1)

v1.1.1(Dec 9, 2022)
Fix on upload by chunk and progressive upload.

Add test on progressive upload.

Add a build.yml CI workflow.

Source code(tar.gz)
Source code(zip)
v1.1.0(Dec 6, 2022)
Refactor upload by chunk and progressive upload. It is now possible to cancel an upload.

Add timeout API

Source code(tar.gz)
Source code(zip)
v1.0.6(Sep 14, 2022)
period parameter is now mandatory in analytics endpoints

Source code(tar.gz)
Source code(zip)
v1.0.5(Jul 5, 2022)
Add SDK origin header

Source code(tar.gz)
Source code(zip)
v1.0.4(Apr 21, 2022)
Fix video.publishedAt type

Source code(tar.gz)
Source code(zip)
v1.0.3(Mar 21, 2022)
Add ingest.receivedParts attribute in GET /videos/{video_id}/status

Source code(tar.gz)
Source code(zip)
v1.0.2(Mar 11, 2022)
Add Origin identification headers

Source code(tar.gz)
Source code(zip)
v1.0.1(Jan 25, 2022)
Add applicationName parameter (to allow user agent extension)

Source code(tar.gz)
Source code(zip)
v1.0.0(Jan 13, 2022)
Add watermark endpoints

Add video clips

Fix tags[] query parameter format of GET /videos

Correctly distinguish between "undefined", "defined" and "null" values of the playerId parameter of PATCH /videos/{videoId}

Source code(tar.gz)
Source code(zip)
v0.1.2(Dec 14, 2021)
Set protocol for progressive upload session visibility to public

Source code(tar.gz)
Source code(zip)
v0.1.1(Dec 14, 2021)
Add a protocol for progressive upload session

Source code(tar.gz)
Source code(zip)
v0.1.0(Dec 9, 2021)
Initial release

Source code(tar.gz)
Source code(zip)