Skip to content

README.md

Latest commit

 

History

History
113 lines (96 loc) · 7.65 KB

README.md

File metadata and controls

113 lines (96 loc) · 7.65 KB

Telestream Cloud Flip Go SDK

This library provides a low-level interface to the REST API of Telestream Cloud, the online video encoding service.

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: 2.0.1
  • Package version: 2.0.4
  • Build package: io.swagger.codegen.languages.GoClientCodegen

Documentation for API Endpoints

All URIs are relative to https://api.cloud.telestream.net/flip/3.1

Class Method HTTP request Description
FlipApi CancelEncoding Post /encodings/{id}/cancel.json Cancels an Encoding.
FlipApi CancelVideo Post /videos/{id}/cancel.json Cancel video and all encodings
FlipApi CopyProfile Post /profiles/{id}/copy.json Copies a given Profile
FlipApi CreateEncoding Post /encodings.json Creates an Encoding
FlipApi CreateFactory Post /factories.json Creates a new factory
FlipApi CreateProfile Post /profiles.json Creates a Profile
FlipApi CreateVideo Post /videos.json Creates a Video from a provided source_url.
FlipApi CreateWorkorder Post /workorders.json Creates a Workorder.
FlipApi DeleteEncoding Delete /encodings/{id}.json Deletes an Encoding from both Telestream Cloud and your storage. Returns an information whether the operation was successful.
FlipApi DeleteProfile Delete /profiles/{id}.json Deletes a given Profile
FlipApi DeleteVideo Delete /videos/{id}.json Deletes a Video object.
FlipApi DeleteVideoSource Delete /videos/{id}/source.json Delete a video's source file.
FlipApi Encoding Get /encodings/{id}.json Returns an Encoding object.
FlipApi Encodings Get /encodings.json Returns a list of Encoding objects
FlipApi EncodingsCount Get /encodings/count.json Returns a number of Encoding objects created using a given factory.
FlipApi Factories Get /factories.json Returns a collection of Factory objects.
FlipApi Factory Get /factories/{id}.json Returns a Factory object.
FlipApi Notifications Get /notifications.json Returns a Factory's notification settings.
FlipApi Profile Get /profiles/{id_or_name}.json Returns a Profile object.
FlipApi ProfileEncodings Get /profiles/{id_or_name}/encodings.json Returns a list of Encodings that belong to a Profile.
FlipApi Profiles Get /profiles.json Returns a collection of Profile objects.
FlipApi QueuedVideos Get /videos/queued.json Returns a collection of Video objects queued for encoding.
FlipApi ResubmitVideo Post /videos/resubmit.json Resubmits a video to encode.
FlipApi RetryEncoding Post /encodings/{id}/retry.json Retries a failed encoding.
FlipApi SignedEncodingUrl Get /encodings/{id}/signed-url.json Returns a signed url pointing to an Encoding.
FlipApi SignedEncodingUrls Get /encodings/{id}/signed-urls.json Returns a list of signed urls pointing to an Encoding's outputs.
FlipApi SignedVideoUrl Get /videos/{id}/signed-url.json Returns a signed url pointing to a Video.
FlipApi ToggleFactorySync Post /factories/{id}/sync.json Toggles synchronisation settings.
FlipApi UpdateEncoding Put /encodings/{id}.json Updates an Encoding
FlipApi UpdateFactory Patch /factories/{id}.json Updates a Factory's settings. Returns a Factory object.
FlipApi UpdateNotifications Put /notifications.json Updates a Factory's notification settings.
FlipApi UpdateProfile Put /profiles/{id}.json Updates a given Profile
FlipApi UploadVideo Post /videos/upload.json Creates an upload session.
FlipApi Video Get /videos/{id}.json Returns a Video object.
FlipApi VideoEncodings Get /videos/{id}/encodings.json Returns a list of Encodings that belong to a Video.
FlipApi VideoMetadata Get /videos/{id}/metadata.json Returns a Video's metadata
FlipApi Videos Get /videos.json Returns a collection of Video objects.
FlipApi Workflows Get /workflows.json Returns a collection of Workflows that belong to a Factory.

Documentation For Models

Documentation For Authorization

api_key

  • Type: API key

Example

	auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
		Key: "APIKEY",
		Prefix: "Bearer", // Omit if not necessary.
	})
    r, err := client.Service.Operation(auth, args)

Author

cloudsupport@telestream.net
⚡