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.3.4

Run carthage update

CocoaPods

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

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

TagsAPI

Retrieve an instance of TagsAPI:

TagsAPI

Endpoints

UploadTokensAPI

Retrieve an instance of UploadTokensAPI:

UploadTokensAPI

Endpoints

VideosAPI

Retrieve an instance of VideosAPI:

VideosAPI

Endpoints

WatermarksAPI

Retrieve an instance of WatermarksAPI:

WatermarksAPI

Endpoints

WebhooksAPI

Retrieve an instance of WebhooksAPI:

WebhooksAPI

Endpoints

Models

• AccessToken

• AdditionalBadRequestErrors

• AnalyticsAggregatedMetricsResponse

• AnalyticsAggregatedMetricsResponseContext

• AnalyticsAggregatedMetricsResponseContextTimeframe

• AnalyticsData

• AnalyticsMetricsBreakdownResponse

• AnalyticsMetricsBreakdownResponseContext

• AnalyticsMetricsBreakdownResponseData

• AnalyticsMetricsOverTimeResponse

• AnalyticsMetricsOverTimeResponseContext

• AnalyticsMetricsOverTimeResponseData

• AnalyticsPlays400Error

• AnalyticsPlaysResponse

• AuthenticatePayload

• BadRequest

• BytesRange

• Caption

• CaptionsListResponse

• CaptionsUpdatePayload

• Chapter

• ChaptersListResponse

• DiscardedVideoUpdatePayload

• FilterBy

• FilterBy1

• FilterBy2

• Link

• ListTagsResponse

• ListTagsResponseData

• LiveStream

• LiveStreamAssets

• LiveStreamCreationPayload

• LiveStreamListResponse

• LiveStreamUpdatePayload

• Metadata

• Model403ErrorSchema

• NotFound

• Pagination

• PaginationLink

• PlayerSessionEvent

• PlayerTheme

• PlayerThemeAssets

• PlayerThemeCreationPayload

• PlayerThemeUpdatePayload

• PlayerThemesListResponse

• Quality

• RefreshTokenPayload

• RestreamsRequestObject

• RestreamsResponseObject

• TokenCreationPayload

• TokenListResponse

• TooManyRequests

• UnrecognizedRequestUrl

• UploadToken

• Video

• VideoAssets

• VideoClip

• VideoCreationPayload

• VideoSource

• VideoSourceLiveStream

• VideoSourceLiveStreamLink

• VideoStatus

• VideoStatusEncoding

• VideoStatusEncodingMetadata

• VideoStatusIngest

• VideoStatusIngestReceivedParts

• VideoThumbnailPickPayload

• VideoUpdatePayload

• VideoWatermark

• VideosListResponse

• Watermark

• WatermarksListResponse

• Webhook

• WebhooksCreationPayload

• WebhooksListResponse

Rate limiting

api.video implements rate limiting to ensure fair usage and stability of the service. The API provides the rate limit values in the response headers for any API requests you make. The /auth endpoint is the only route without rate limitation.

In this client, you can access these headers by using the methods with the completion: @escaping (_ result: Swift.Result<Response<T>, ErrorResponse>) -> Void) parameters. These methods return both the response body and the headers, allowing you to check the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Retry-After headers to understand your current rate limit status. Read more about these response headers in the API reference.

try VideosAPI.uploadWithUploadToken(token: "MY_UPLOAD_TOKEN", file: url) { result in
    switch result {
    case .success(let response):
        print("X-RateLimit-Limit:  \(String(describing: response.header["X-RateLimit-Limit"]))")
        print("X-RateLimit-Remaining:  \(String(describing: response.header["X-RateLimit-Remaining"]))")
        print("X-RateLimit-Retry-After:  \(String(describing: response.header["X-RateLimit-Retry-After"]))")
    case .failure(_):
        break
    }
}

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.