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
• Getting started
  • Installation
    • Carthage
    • CocoaPods
  • Code sample
• Documentation
  • API Endpoints
    • CaptionsAPI
    • ChaptersAPI
    • LiveStreamsAPI
    • PlayerThemesAPI
    • RawStatisticsAPI
    • UploadTokensAPI
    • VideosAPI
    • WebhooksAPI
  • Models
  • Authorization
    • API token
    • Public endpoints
• 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

ChaptersAPI

Retrieve an instance of ChaptersAPI:

ChaptersAPI

Endpoints

LiveStreamsAPI

Retrieve an instance of LiveStreamsAPI:

LiveStreamsAPI

Endpoints

PlayerThemesAPI

Retrieve an instance of PlayerThemesAPI:

PlayerThemesAPI

Endpoints

RawStatisticsAPI

Retrieve an instance of RawStatisticsAPI:

RawStatisticsAPI

Endpoints

UploadTokensAPI

Retrieve an instance of UploadTokensAPI:

UploadTokensAPI

Endpoints

VideosAPI

Retrieve an instance of VideosAPI:

VideosAPI

Endpoints

WebhooksAPI

Retrieve an instance of WebhooksAPI:

WebhooksAPI

Endpoints

Models

• AccessToken
• AuthenticatePayload
• BadRequest
• BytesRange
• Caption
• CaptionsListResponse
• CaptionsUpdatePayload
• Chapter
• ChaptersListResponse
• Link
• LiveStream
• LiveStreamAssets
• LiveStreamCreationPayload
• LiveStreamListResponse
• LiveStreamSession
• LiveStreamSessionClient
• LiveStreamSessionDevice
• LiveStreamSessionLocation
• LiveStreamSessionReferrer
• LiveStreamSessionSession
• LiveStreamUpdatePayload
• Metadata
• NotFound
• Pagination
• PaginationLink
• PlayerSessionEvent
• PlayerTheme
• PlayerThemeAssets
• PlayerThemeCreationPayload
• PlayerThemeUpdatePayload
• PlayerThemesListResponse
• Quality
• RawStatisticsListLiveStreamAnalyticsResponse
• RawStatisticsListPlayerSessionEventsResponse
• RawStatisticsListSessionsResponse
• RefreshTokenPayload
• TokenCreationPayload
• TokenListResponse
• UploadToken
• Video
• VideoAssets
• VideoCreationPayload
• VideoSession
• VideoSessionClient
• VideoSessionDevice
• VideoSessionLocation
• VideoSessionOs
• VideoSessionReferrer
• VideoSessionSession
• VideoSource
• VideoSourceLiveStream
• VideoSourceLiveStreamLink
• VideoStatus
• VideoStatusEncoding
• VideoStatusEncodingMetadata
• VideoStatusIngest
• VideoThumbnailPickPayload
• VideoUpdatePayload
• VideosListResponse
• Webhook
• WebhooksCreationPayload
• WebhooksListResponse

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.