service

Documentation

Index

• func AudioDownmixMapping(ad db.AudioDownmix) ([][]bool, error)
• type NewTranscodeJobInputPayload
• type PartialJob
• type TranscodingService
  • func NewTranscodingService(cfg *config.Config, logger *logrus.Logger) (*TranscodingService, error)
  • func (s *TranscodingService) Endpoints() map[string]map[string]http.HandlerFunc
  • func (s *TranscodingService) JSONEndpoints() map[string]map[string]server.JSONEndpoint
  • func (s *TranscodingService) JSONMiddleware(j server.JSONEndpoint) server.JSONEndpoint
  • func (s *TranscodingService) Middleware(h http.Handler) http.Handler
  • func (s *TranscodingService) Prefix() string

Functions

func AudioDownmixMapping

func AudioDownmixMapping(ad db.AudioDownmix) ([][]bool, error)

AudioDownmixMapping converts

Types

type NewTranscodeJobInputPayload

type NewTranscodeJobInputPayload struct {
	// source media for the transcoding job.
	Source string `json:"source"`

	// SourceInfo is an optional param allowing users to add helpful information about the source content
	SourceInfo db.File `json:"sourceInfo,omitempty"`

	// SourceSplice is a set of second ranges to excise from the input and catenate
	// together before processing the source. For example, [[0,1],[8,9]], will cut out
	// a two-second clip, from the first and last second of a 10s video.
	SourceSplice timecode.Splice `json:"splice,omitempty"`

	// list of outputs in this job
	Outputs []struct {
		FileName string `json:"fileName"`
		Preset   string `json:"preset"`
	} `json:"outputs"`

	// provider to use in this job
	Provider string `json:"provider"`

	// Name is an optional client-supplied name for the job
	Name string `json:"name,omitempty"`

	// ExecutionFeatures holds custom provider-specific execution features configuration
	ExecutionFeatures db.ExecutionFeatures `json:"executionFeatures,omitempty"`

	// ExecutionEnv contains configurations for the environment used while transcoding
	ExecutionEnv db.ExecutionEnvironment `json:"executionEnv,omitempty"`

	// SidecarAssets holds the location of any sidecar assets associated with the transcode
	SidecarAssets map[db.SidecarAssetKind]string `json:"sidecarAssets,omitempty"`

	// DestinationBasePath is an optional param allowing users to overwrite the location of outputs pre job
	DestinationBasePath string `json:"destinationBasePath,omitempty"`

	// provider Adaptive Streaming parameters
	StreamingParams db.StreamingParams `json:"streamingParams,omitempty"`

	// ExplicitKeyframeOffsets define offsets from the beginning of the media to insert keyframes when encoding
	ExplicitKeyframeOffsets []float64 `json:"explicitKeyframeOffsets,omitempty"`

	// Labels for jobs for grouping/searching later on
	Labels []string `json:"labels,omitempty"`
}

NewTranscodeJobInputPayload makes up the parameters available for specifying a new transcoding job

type PartialJob

type PartialJob struct {
	// unique identifier of the job
	//
	// unique: true
	JobID string `json:"jobId"`
}

PartialJob is the simple response given to an API call that creates a new transcoding job swagger:model

type TranscodingService

type TranscodingService struct {
	// contains filtered or unexported fields
}

TranscodingService will implement server.JSONService and handle all requests to the server.

func NewTranscodingService

func NewTranscodingService(cfg *config.Config, logger *logrus.Logger) (*TranscodingService, error)

NewTranscodingService will instantiate a JSONService with the given configuration.

func (*TranscodingService) Endpoints

func (s *TranscodingService) Endpoints() map[string]map[string]http.HandlerFunc

Endpoints is a list of all non-json endpoints.

func (*TranscodingService) JSONEndpoints

func (s *TranscodingService) JSONEndpoints() map[string]map[string]server.JSONEndpoint

JSONEndpoints is a listing of all endpoints available in the JSONService.

func (*TranscodingService) JSONMiddleware

func (s *TranscodingService) JSONMiddleware(j server.JSONEndpoint) server.JSONEndpoint

JSONMiddleware provides a JSONEndpoint hook wrapped around all requests.

func (*TranscodingService) Middleware

func (s *TranscodingService) Middleware(h http.Handler) http.Handler

Middleware provides an http.Handler hook wrapped around all requests. In this implementation, we're using a GzipHandler middleware to compress our responses.

func (*TranscodingService) Prefix

func (s *TranscodingService) Prefix() string

Prefix returns the string prefix used for all endpoints within this service.