iOS API client
Getting started
Installation
Carthage
Specify it in your Cartfile
:
github "apivideo/api.video-ios-client" ~> 1.2.1
Run carthage update
CocoaPods
Add pod 'ApiVideoClient', '1.2.1'
in your Podfile
Run pod install
Code sample
Please follow the installation instruction and execute the following Swift code:
.apiKey =
// if you rather like to use the sandbox environment:
// ApiVideoClient.basePath = Environment.sandbox.rawValue
let url = URL(string: )
VideosAPI.create(videoCreationPayload: VideoCreationPayload(title: )) { video, error in
if let video = video {
do {
try 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
}
}
} catch {
// Manage error on file here
}
}
if let error = error {
// Manage create error here
}
}
ApiVideoClient
Documentation
API Endpoints
All URIs are relative to https://ws.api.video
AnalyticsAPI
Retrieve an instance of AnalyticsAPI:
AnalyticsAPI
Endpoints
Method | HTTP request | Description |
---|---|---|
getLiveStreamsPlays | GET /analytics/live-streams/plays | Get play events for live stream |
getVideosPlays | GET /analytics/videos/plays | Get play events for 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 |
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 object |
upload | POST /videos/{videoId}/source | Upload a video |
uploadWithUploadToken | POST /upload | Upload with an delegated upload token |
get | GET /videos/{videoId} | Retrieve a video object |
update | PATCH /videos/{videoId} | Update a video object |
delete | DELETE /videos/{videoId} | Delete a video object |
list | GET /videos | List all video objects |
uploadThumbnail | POST /videos/{videoId}/thumbnail | Upload a thumbnail |
pickThumbnail | PATCH /videos/{videoId}/thumbnail | Set a thumbnail |
getStatus | GET /videos/{videoId}/status | Retrieve video status and details |
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
- AccessToken
- AdditionalBadRequestErrors
- AnalyticsData
- AnalyticsPlays400Error
- AnalyticsPlaysResponse
- AuthenticatePayload
- BadRequest
- BytesRange
- Caption
- CaptionsListResponse
- CaptionsUpdatePayload
- Chapter
- ChaptersListResponse
- Link
- LiveStream
- LiveStreamAssets
- LiveStreamCreationPayload
- LiveStreamListResponse
- LiveStreamSession
- LiveStreamSessionClient
- LiveStreamSessionDevice
- LiveStreamSessionLocation
- LiveStreamSessionReferrer
- LiveStreamSessionSession
- LiveStreamUpdatePayload
- Metadata
- Model403ErrorSchema
- NotFound
- Pagination
- PaginationLink
- PlayerSessionEvent
- PlayerTheme
- PlayerThemeAssets
- PlayerThemeCreationPayload
- PlayerThemeUpdatePayload
- PlayerThemesListResponse
- Quality
- RefreshTokenPayload
- RestreamsRequestObject
- RestreamsResponseObject
- TokenCreationPayload
- TokenListResponse
- UploadToken
- Video
- VideoAssets
- VideoClip
- VideoCreationPayload
- VideoSession
- VideoSessionClient
- VideoSessionDevice
- VideoSessionLocation
- VideoSessionOs
- VideoSessionReferrer
- VideoSessionSession
- VideoSource
- VideoSourceLiveStream
- VideoSourceLiveStreamLink
- VideoStatus
- VideoStatusEncoding
- VideoStatusEncodingMetadata
- VideoStatusIngest
- VideoStatusIngestReceivedParts
- VideoThumbnailPickPayload
- VideoUpdatePayload
- VideoWatermark
- VideosListResponse
- Watermark
- WatermarksListResponse
- Webhook
- WebhooksCreationPayload
- WebhooksListResponse
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.
Was this page helpful?