clients

Documentation

Index

• Variables
• func CatalystHookPath(apiRoot, taskId string) string
• func IsInputError(err error) bool
• func RedactURL(urlStr string) string
• type BaseClient
  • func (c *BaseClient) DoRequest(ctx context.Context, r Request, output interface{}) error
• type Catalyst
  • func NewCatalyst(opts CatalystOptions) Catalyst
• type CatalystCallback
• type CatalystOptions
• type ClipStrategy
• type EncryptionPayload
• type HTTPStatusError
  • func (e *HTTPStatusError) Error() string
• type IPFS
  • func NewPinataClientAPIKey(apiKey, apiSecret string, filesMetadata map[string]string) IPFS
  • func NewPinataClientJWT(jwt string, filesMetadata map[string]string) IPFS
• type OutputLocation
• type OutputsRequest
• type PinInfo
• type PinList
• type Request
• type UploadVODRequest

Variables

var (
	ErrRateLimited = errors.New("rate limited")
)

var UserAgent string

Functions

func CatalystHookPath

func CatalystHookPath(apiRoot, taskId string) string

func IsInputError

func IsInputError(err error) bool

func RedactURL

func RedactURL(urlStr string) string

Types

type BaseClient

type BaseClient struct {
	*http.Client
	BaseUrl     string
	BaseHeaders map[string]string
}

func (*BaseClient) DoRequest

func (c *BaseClient) DoRequest(ctx context.Context, r Request, output interface{}) error

type Catalyst

type Catalyst interface {
	UploadVOD(ctx context.Context, upload UploadVODRequest) error
	CatalystHookURL(taskId, nextStep, attemptID string) string
}

func NewCatalyst

func NewCatalyst(opts CatalystOptions) Catalyst

type CatalystCallback

type CatalystCallback = clients.TranscodeStatusMessage

type CatalystOptions

type CatalystOptions struct {
	BaseURL                 string
	Secret                  string
	OwnBaseURL              *url.URL
	RateLimitInitialBackoff time.Duration
}

type ClipStrategy

type ClipStrategy struct {
	StartTime  int64  `json:"start_time,omitempty"`
	EndTime    int64  `json:"end_time,omitempty"`
	PlaybackID string `json:"playback_id,omitempty"` // playback-id of asset to clip
}

type EncryptionPayload

type EncryptionPayload struct {
	EncryptedKey string `json:"encrypted_key"`
}

type HTTPStatusError

type HTTPStatusError struct {
	Status int
	Body   string
}

func (*HTTPStatusError) Error

func (e *HTTPStatusError) Error() string

type IPFS

type IPFS interface {
	PinContent(ctx context.Context, name, contentType string, data io.Reader) (cid string, metadata interface{}, err error)
	Unpin(ctx context.Context, cid string) error
	List(ctx context.Context, pageSize, pageOffset int) (*PinList, int, error)
}

func NewPinataClientAPIKey

func NewPinataClientAPIKey(apiKey, apiSecret string, filesMetadata map[string]string) IPFS

func NewPinataClientJWT

func NewPinataClientJWT(jwt string, filesMetadata map[string]string) IPFS

type OutputLocation

type OutputLocation struct {
	Type            string          `json:"type"`
	URL             string          `json:"url,omitempty"`
	PinataAccessKey string          `json:"pinata_access_key,omitempty"`
	Outputs         *OutputsRequest `json:"outputs,omitempty"`
}

type OutputsRequest

type OutputsRequest struct {
	SourceMp4  bool   `json:"source_mp4"`
	HLS        string `json:"hls"`
	MP4        string `json:"mp4"`
	FMP4       string `json:"fragmented_mp4"`
	Clip       string `json:"clip"`
	Thumbnails string `json:"thumbnails"`
}

type PinInfo

type PinInfo struct {
	ID          string `json:"id"`
	IPFSPinHash string `json:"ipfs_pin_hash"`
	Size        int64  `json:"size"`
	DatePinned  string `json:"date_pinned"`
	Metadata    struct {
		Name      string            `json:"name"`
		KeyValues map[string]string `json:"keyvalues"`
	} `json:"metadata"`
}

type PinList

type PinList struct {
	Pins []PinInfo `json:"rows"`
}

type Request

type Request struct {
	Method, URL string
	Body        io.Reader
	ContentType string
	Headers     map[string]string
}

type UploadVODRequest

type UploadVODRequest struct {
	ExternalID            string             `json:"external_id,omitempty"`
	Url                   string             `json:"url"`
	CallbackUrl           string             `json:"callback_url"`
	OutputLocations       []OutputLocation   `json:"output_locations,omitempty"`
	Profiles              []api.Profile      `json:"profiles,omitempty"`
	PipelineStrategy      pipeline.Strategy  `json:"pipeline_strategy,omitempty"`
	TargetSegmentSizeSecs int64              `json:"target_segment_size_secs,omitempty"`
	Encryption            *EncryptionPayload `json:"encryption,omitempty"`
	ClipStrategy          ClipStrategy       `json:"clip_strategy,omitempty"`
	C2PA                  bool               `json:"c2pa,omitempty"`
}