Swiftpack.co - apivideo/api.video-ios-client as Swift Package

Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.
See all packages published by apivideo.
apivideo/api.video-ios-client v1.0.5
The official iOS client library for api.video
⭐️ 5
🕓 5 weeks ago
iOS macOS watchOS tvOS
.package(url: "https://github.com/apivideo/api.video-ios-client.git", from: "v1.0.5")

badge   badge   badge

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

Run carthage update

CocoaPods

Add pod 'ApiVideoClient', '1.0.5' 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_KEY"
    // 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
upload POST /videos/{videoId}/captions/{language} Upload a caption
get GET /videos/{videoId}/captions/{language} Retrieve a caption
update PATCH /videos/{videoId}/captions/{language} Update a caption
delete DELETE /videos/{videoId}/captions/{language} Delete a caption
list GET /videos/{videoId}/captions List video captions

ChaptersAPI

Retrieve an instance of ChaptersAPI:

ChaptersAPI

Endpoints

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

LiveStreamsAPI

Retrieve an instance of LiveStreamsAPI:

LiveStreamsAPI

Endpoints

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

PlayerThemesAPI

Retrieve an instance of PlayerThemesAPI:

PlayerThemesAPI

Endpoints

Method HTTP request Description
create POST /players Create a player
get GET /players/{playerId} Retrieve a player
update PATCH /players/{playerId} Update a player
delete DELETE /players/{playerId} Delete a player
list GET /players List all player themes
uploadLogo POST /players/{playerId}/logo Upload a logo
deleteLogo DELETE /players/{playerId}/logo Delete 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
createToken POST /upload-tokens Generate an upload token
getToken GET /upload-tokens/{uploadToken} Retrieve upload token
deleteToken DELETE /upload-tokens/{uploadToken} Delete an upload token
list GET /upload-tokens List all active upload tokens.

VideosAPI

Retrieve an instance of VideosAPI:

VideosAPI

Endpoints

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

WatermarksAPI

Retrieve an instance of WatermarksAPI:

WatermarksAPI

Endpoints

Method HTTP request Description
upload POST /watermarks Upload a watermark
delete DELETE /watermarks/{watermarkId} Delete a watermark
list GET /watermarks List all watermarks

WebhooksAPI

Retrieve an instance of WebhooksAPI:

WebhooksAPI

Endpoints

Method HTTP request Description
create POST /webhooks Create Webhook
get GET /webhooks/{webhookId} Retrieve Webhook details
delete DELETE /webhooks/{webhookId} Delete a Webhook
list GET /webhooks List all webhooks

Models

Documentation for Authorization

API key

Most endpoints required to be authenticated using the API key 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 key:

ApiVideoClient.apiKey = YOUR_API_KEY

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.

GitHub

link
Stars: 5
Last commit: 5 weeks ago
jonrohan Something's broken? Yell at me @ptrpavlik. Praise and feedback (and money) is also welcome.

Release Notes

v1.0.5
5 weeks ago
  • Add SDK origin header

Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics