api

May 27, 2024

Changes in this version

type Asset

+ ProjectID string

type Client

+ func (lapi *Client) FlagAssetAsDeleted(assetID string) error

+ func (lapi *Client) GetDeletingAssets() ([]*Asset, error)

type ListOptions

+ IncludeDeleting bool

type Stream

+ ProjectID string

Apr 15, 2024

Changes in this version

type Stream

+ PullRegion string

Mar 25, 2024

Changes in this version

type Client

+ func (lapi *Client) LockPull(id string, leaseTimeoutMs time.Duration) error

Mar 6, 2024

Changes in this version

type Asset

+ CreatorID *CreatorID

+ type CreatorID struct

+ Type string

+ Value string

type Stream

+ CreatorID *CreatorID

Feb 12, 2024

Changes in this version

type UploadTaskParams

+ TargetSegmentSizeSecs int64

Feb 8, 2024

Changes in this version

type UploadTaskParams

+ Profiles []Profile

Jan 31, 2024

Changes in this version

type Stream

+ Pull *StreamPull

+ type StreamPull struct

+ Headers map[string]string

+ Location ...

+ Source string

Dec 13, 2023

Changes in this version

type CreateStreamReq

+ CreatorID string

+ ObjectStoreId string

+ PlaybackPolicy *PlaybackPolicy

+ type PlaybackPolicy struct

+ Type string

+ WebhookContext map[string]interface{}

+ WebhookID string

type Profile

+ Quality int

type Stream

+ IsActive bool

Nov 13, 2023

Changes in this version

type Asset

+ SourcePlaybackReady bool

Nov 7, 2023

Changes in this version

type Client

+ func (lapi *Client) Heartbeat(id string) error

Oct 26, 2023

Changes in this version

+ type ClipTaskParams struct

+ CatalystPipelineStrategy string

+ ClipStrategy struct{ ... }

+ InputID string

+ InputSessionID string

+ SourceObjectStoreID string

+ URL string

type Stream

+ Suspended bool

type TranscodeFileTaskParams

+ C2PA bool

type UploadTaskParams

+ C2PA bool

+ Thumbnails bool

Aug 18, 2023

Changes in this version

type TranscodeFileReqOutputs

+ FMp4 TranscodeFileReqOutput

Jun 23, 2023

Changes in this version

+ type ExportCustomParams struct

+ Headers map[string]string

+ Method string

+ URL string

+ type ExportDataTaskParams struct

+ Content json.RawMessage

+ Custom *ExportCustomParams

+ ID string

+ IPFS *ExportIPFSParams

+ Type string

+ type ExportIPFSParams struct

+ NFTMetadata map[string]interface{}

+ Pinata ...

May 5, 2023

Changes in this version

type Asset

+ Source AssetSource

+ type AssetSource struct

+ Type string

Mar 31, 2023

Changes in this version

+ type TranscodeFileReqOutput struct

+ Path string

type TranscodeFileReqOutputs

+ Mp4 TranscodeFileReqOutput

Mar 15, 2023

Changes in this version

type Asset

+ StaticMp4 bool

Mar 9, 2023

Changes in this version

type Asset

+ GenerateMp4s bool

type TranscodeFileTaskParams

+ TargetSegmentSizeSecs int64

Feb 14, 2023

Changes in this version

type AssetFile

+ Spec AssetFileSpec

+ type AssetFileSpec struct

+ Bitrate int64

+ Height int64

+ Size int64

+ Width int64

type Client

+ func (lapi *Client) GetPlaybackInfo(pid string) (*PlaybackInfo, error)

+ type HRN string

+ const HRN_HLS

+ type PlaybackInfo struct

+ Meta struct{ ... }

+ Type PlaybackInfoType

+ type PlaybackInfoSource struct

+ Hrn HRN

+ Type PlaybackInfoSourceType

+ Url string

+ type PlaybackInfoSourceType string

+ const PlaybackInfoSourceTypeHLS

+ type PlaybackInfoType string

+ const PlaybackInfoTypeLive

+ const PlaybackInfoTypeRecording

+ const PlaybackInfoTypeVod

type TaskStatus

+ Step string

type TranscodeFileReqCredentials

+ Proof string

+ type TranscodeFileTaskOutputPath struct

+ Path string

type UploadTaskParams

+ Encryption struct{ ... }

Jan 27, 2023

Changes in this version

type Client

+ func (lapi *Client) TranscodeFile(tfr TranscodeFileReq) (*Task, error)

+ type HTTPStatusError struct

+ Message string

+ StatusCode int

+ func (e *HTTPStatusError) Error() string

+ type TranscodeFileReq struct

+ Input TranscodeFileReqInput

+ Outputs TranscodeFileReqOutputs

+ Storage TranscodeFileReqStorage

+ type TranscodeFileReqCredentials struct

+ AccessKeyId string

+ SecretAccessKey string

+ type TranscodeFileReqInput struct

+ Bucket string

+ Credentials *TranscodeFileReqCredentials

+ Endpoint string

+ Path string

+ Type string

+ Url string

+ type TranscodeFileReqOutputs struct

+ Hls TranscodeFileReqOutputsHls

+ type TranscodeFileReqOutputsHls struct

+ Path string

+ type TranscodeFileReqStorage struct

+ Bucket string

+ Credentials *TranscodeFileReqCredentials

+ Endpoint string

+ Type string

+ type TranscodeFileTaskParams struct

+ CatalystPipelineStrategy string

+ Input struct{ ... }

+ Outputs struct{ ... }

+ Profiles []Profile

+ Storage struct{ ... }

Dec 7, 2022

Changes in this version

type Client

+ func (lapi *Client) UploadViaURL(url, name, catalystStrategy string) (*Asset, *Task, error)

type UploadTaskParams

+ CatalystPipelineStrategy string

Dec 7, 2022

Changes in this version

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

type Asset

+ DownloadURL string

+ PlaybackURL string

+ type AssetFile struct

+ Path string

+ Type string

type AssetSpec

+ Files []AssetFile

Sep 23, 2022

Changes in this version

type Asset

+ SourceAssetID string

+ type AssetIPFS struct

+ NFTMetadata *IPFSFileInfo

+ Spec struct{ ... }

type AssetSpec

+ Storage AssetStorage

+ type AssetStorage struct

+ IPFS *AssetIPFS

+ Status struct{ ... }

type Client

+ func (lapi *Client) RequestUpload(name string) (*UploadUrls, error)

+ func (lapi *Client) ResumableUpload(url string, file *os.File) error

+ func (lapi *Client) UploadAsset(ctx context.Context, url string, file io.Reader) error

+ type IPFSFileInfo struct

+ CID string

+ GatewayUrl string

+ Url string

type Stream

+ Mp4Url string

+ RecordingStatus string

+ RecordingURL string

+ type TaskOnlyId struct

+ ID string

+ type TaskPhase string

+ const TaskPhaseCompleted

+ const TaskPhaseFailed

+ const TaskPhasePending

+ const TaskPhaseRunning

+ const TaskPhaseWaiting

type TaskStatus

+ Retries int

+ type UploadTaskParams struct

+ RecordedSessionID string

+ URL string

+ UploadedObjectKey string

+ type UploadUrls struct

+ Asset Asset

+ Task TaskOnlyId

+ TusEndpoint string

+ Url string

Jul 27, 2022

Changes in this version

type Client

+ func (lapi *Client) CreateStreamR(csr CreateStreamReq) (stream *Stream, err error)

Jul 21, 2022

Changes in this version

type Asset

+ Deleted bool

type Client

+ func (lapi *Client) DeleteAsset(id string) error

+ func (lapi *Client) GetAssetByPlaybackID(pid string, includeDeleted bool) (*Asset, error)

+ type ListOptions struct

+ AllUsers bool

+ Cursor string

+ Filters map[string]interface{}

+ IncludeDeleted bool

+ Limit int

+ Order map[string]bool

Jun 29, 2022

Changes in this version

type AssetStatus

+ ErrorMessage string

type TaskStatus

+ ErrorMessage string

Jun 23, 2022

Changes in this version

type Asset

+ Status AssetStatus

+ type AssetStatus struct

+ Phase string

+ UpdatedAt int64

type Client

+ func (lapi *Client) ExportAsset(assetId string) (*Task, error)

+ func (lapi *Client) ImportAsset(url string, name string) (*Asset, *Task, error)

+ func (lapi *Client) ListAssets() (*[]Asset, error)

+ func (lapi *Client) TranscodeAsset(assetId string, name string, profile Profile) (*Asset, *Task, error)

+ type ExportAssetResp struct

+ Task Task

+ type IPFS struct

+ NFTMetadata interface{}

+ Pinata *Pinata

+ type Pinata struct

+ APIKey string

+ APISecret string

+ JWT string

type Task

+ Output ...

+ type TaskAndAsset struct

+ Asset Asset

+ Task Task

Jun 15, 2022

Changes in this version

type ImportTaskParams

+ RecordedSessionID string

Jun 14, 2022

Changes in this version

type Client

+ func (lapi *Client) PushSegmentR(sid string, seqNo int, dur time.Duration, segData []byte, resolution string) (transcoded [][]byte, err error)

+ type CreateStreamReq struct

+ Name string

+ ParentID string

+ Presets []string

+ Profiles []Profile

+ Record bool

+ RecordObjectStoreId string

+ type Stream struct

+ CreatedAt int64

+ Deleted bool

+ ID string

+ Kind string

+ LastSeen int64

+ Multistream struct{ ... }

+ Name string

+ ParentID string

+ PlaybackID string

+ Presets []string

+ Profiles []Profile

+ Record bool

+ SourceSegments int64

+ SourceSegmentsDuration float64

+ StreamKey string

+ TranscodedSegments int64

+ TranscodedSegmentsDuration float64

+ UserID string

May 31, 2022

Changes in this version

+ type NFTMetadataTemplate string

+ const NFTMetadataTemplateFile

+ const NFTMetadataTemplatePlayer

May 2, 2022

Changes in this version

type AssetSpec

+ PlaybackRecordingID string

Mar 29, 2022

Changes in this version

type TranscodeTaskParams

+ Profile Profile

Mar 29, 2022

Changes in this version

+ const DEBUG

+ const INSANE

+ const INSANE2

+ const ProdServer

+ const RecordingStatusReady

+ const RecordingStatusWaiting

+ const SHORT

+ const VERBOSE

+ const VVERBOSE

+ var ErrNotExists = errors.New("not found")

+ var StandardProfiles = []Profile

+ func GeolocateAPIServer() (string, error)

+ func MustGeolocateAPIServer() string

+ func Timedout(e error) bool

+ type Asset struct

+ CreatedAt int64

+ ID string

+ ObjectStoreID string

+ PlaybackID string

+ SourceAssetId string

+ UserID string

+ type AssetHash struct

+ Algorithm string

+ Hash string

+ type AssetSpec struct

+ Hash []AssetHash

+ Name string

+ Size uint64

+ Type string

+ VideoSpec *AssetVideoSpec

+ type AssetTrack struct

+ BitDepth int

+ Bitrate float64

+ Channels int

+ Codec string

+ DurationSec float64

+ FPS float64

+ Height int

+ PixelFormat string

+ SampleRate int

+ StartTime float64

+ Type string

+ Width int

+ type AssetVideoSpec struct

+ Bitrate float64

+ DurationSec float64

+ Format string

+ Tracks []*AssetTrack

+ type Client struct

+ func NewAPIClient(opts ClientOptions) *Client

+ func NewAPIClientGeolocated(opts ClientOptions) (*Client, string)

+ func (lapi *Client) Broadcasters() ([]string, error)

+ func (lapi *Client) CreateStream(name string, presets ...string) (string, error)

+ func (lapi *Client) CreateStreamEx(name string, record bool, presets []string, profiles ...Profile) (*CreateStreamResp, error)

+ func (lapi *Client) CreateStreamEx2(name string, record bool, parentID string, presets []string, ...) (*CreateStreamResp, error)

+ func (lapi *Client) DeactivateMany(ids []string) (int, error)

+ func (lapi *Client) DefaultPresets() []string

+ func (lapi *Client) DeleteStream(id string) error

+ func (lapi *Client) GetAsset(id string) (*Asset, error)

+ func (lapi *Client) GetMultistreamTarget(id string) (*MultistreamTarget, error)

+ func (lapi *Client) GetMultistreamTargetR(id string) (*MultistreamTarget, error)

+ func (lapi *Client) GetObjectStore(id string) (*ObjectStore, error)

+ func (lapi *Client) GetServer() string

+ func (lapi *Client) GetSessions(id string, forceUrl bool) ([]UserSession, error)

+ func (lapi *Client) GetSessionsNew(id string, forceUrl bool) ([]UserSession, error)

+ func (lapi *Client) GetSessionsNewR(id string, forceUrl bool) ([]UserSession, error)

+ func (lapi *Client) GetSessionsR(id string, forceUrl bool) ([]UserSession, error)

+ func (lapi *Client) GetStream(id string) (*CreateStreamResp, error)

+ func (lapi *Client) GetStreamByKey(key string) (*CreateStreamResp, error)

+ func (lapi *Client) GetStreamByPlaybackID(playbackID string) (*CreateStreamResp, error)

+ func (lapi *Client) GetTask(id string) (*Task, error)

+ func (lapi *Client) Ingest(all bool) ([]Ingest, error)

+ func (lapi *Client) PushSegment(sid string, seqNo int, dur time.Duration, segData []byte) ([][]byte, error)

+ func (lapi *Client) SetActive(id string, active bool, startedAt time.Time) (bool, error)

+ func (lapi *Client) SetActiveR(id string, active bool, startedAt time.Time) (bool, error)

+ func (lapi *Client) UpdateTaskStatus(id string, phase string, progress float64) error

+ type ClientOptions struct

+ AccessToken string

+ Metrics metrics.APIRecorder

+ Presets []string

+ Server string

+ Timeout time.Duration

+ UserAgent string

+ type CreateStreamResp struct

+ CreatedAt int64

+ Deleted bool

+ Errors []string

+ ID string

+ Kind string

+ LastSeen int64

+ Multistream struct{ ... }

+ Name string

+ ParentID string

+ PlaybackID string

+ Presets []string

+ Profiles []Profile

+ Record bool

+ SourceSegments int64

+ SourceSegmentsDuration float64

+ StreamKey string

+ TranscodedSegments int64

+ TranscodedSegmentsDuration float64

+ UserID string

+ type ExportTaskParams struct

+ Custom ...

+ IPFS ...

+ type ImportTaskParams struct

+ URL string

+ UploadedObjectKey string

+ type Ingest struct

+ Base string

+ Ingest string

+ Playback string

+ type MultistreamTarget struct

+ CreatedAt int64

+ Disabled bool

+ ID string

+ Name string

+ URL string

+ UserID string

+ type MultistreamTargetRef struct

+ ID string

+ Profile string

+ VideoOnly bool

+ type ObjectStore struct

+ CreatedAt int64

+ Disabled bool

+ ID string

+ Name string

+ PublicURL string

+ URL string

+ UserId string

+ type Profile struct

+ Bitrate int

+ Encoder string

+ Fps int

+ FpsDen int

+ Gop string

+ Height int

+ Name string

+ Profile string

+ Width int

+ type Task struct

+ CreatedAt int64

+ ID string

+ InputAssetID string

+ OutputAssetID string

+ OutputAssetsIDs []string

+ Params struct{ ... }

+ Status TaskStatus

+ Type string

+ UserID string

+ type TaskStatus struct

+ Phase string

+ Progress float64

+ UpdatedAt int64

+ type TranscodeTaskParams struct

+ Profiles []Profile

+ type UserSession struct

+ Mp4Url string

+ RecordingStatus string

+ RecordingURL string