[]()  

api.video Swift 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
    • AnalyticsAPI
    • CaptionsAPI
    • ChaptersAPI
    • LiveStreamsAPI
    • PlayerThemesAPI
    • SummariesAPI
    • TagsAPI
    • UploadTokensAPI
    • VideosAPI
    • WatermarksAPI
    • WebhooksAPI
  • Models
  • Authorization
    • API key
    • Public endpoints
• Have you gotten use from this API client?
• Contribution

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

  Run carthage update

  CocoaPods

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

  Method	HTTP request	Description
  getAggregatedMetrics	GET /data/metrics/{metric}/{aggregation}	Retrieve aggregated metrics
  getMetricsBreakdown	GET /data/buckets/{metric}/{breakdown}	Retrieve metrics in a breakdown of dimensions
  getMetricsOverTime	GET /data/timeseries/{metric}	Retrieve metrics over time

  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
  complete	PUT /live-streams/{liveStreamId}/complete	Complete a live stream

  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

  SummariesAPI

  Retrieve an instance of SummariesAPI:

  SummariesAPI

  Endpoints

  Method	HTTP request	Description
  create	POST /summaries	Generate video summary
  update	PATCH /summaries/{summaryId}/source	Update summary details
  delete	DELETE /summaries/{summaryId}	Delete video summary
  list	GET /summaries	List summaries
  getSummarySource	GET /summaries/{summaryId}/source	Get summary details

  TagsAPI

  Retrieve an instance of TagsAPI:

  TagsAPI

  Endpoints

  Method	HTTP request	Description
  list	GET /tags	List all video tags

  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
  getDiscarded	GET /discarded/videos/{videoId}	Retrieve a discarded video object
  getStatus	GET /videos/{videoId}/status	Retrieve video status and details
  listDiscarded	GET /discarded/videos	List all discarded video objects
  updateDiscarded	PATCH /discarded/videos/{videoId}	Update a discarded video object

  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
  • AnalyticsAggregatedMetricsResponse
  • AnalyticsAggregatedMetricsResponseContext
  • AnalyticsAggregatedMetricsResponseContextTimeframe
  • AnalyticsData
  • AnalyticsMetricsBreakdownResponse
  • AnalyticsMetricsBreakdownResponseContext
  • AnalyticsMetricsBreakdownResponseData
  • AnalyticsMetricsOverTimeResponse
  • AnalyticsMetricsOverTimeResponseContext
  • AnalyticsMetricsOverTimeResponseData
  • AnalyticsPlays400Error
  • AnalyticsPlaysResponse
  • AuthenticatePayload
  • BadRequest
  • BytesRange
  • Caption
  • CaptionsListResponse
  • CaptionsUpdatePayload
  • Chapter
  • ChaptersListResponse
  • ConflictError
  • 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
  • SummariesListResponse
  • Summary
  • SummaryCreationPayload
  • SummarySource
  • SummaryUpdatePayload
  • 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.