components

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 11, 2025 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AudioInput

type AudioInput struct {
	// Type of overlay (currently only supports 'audio').
	Type *AudioInputType `json:"type,omitempty"`
	// URL of the audio track to replace the existing audio in the video.
	SwapTrackURL *string `json:"swapTrackUrl,omitempty"`
	// List of additional audio tracks to overlay on the video.
	ImposeTracks []ImposeTrack `json:"imposeTracks,omitempty"`
}

func (*AudioInput) GetImposeTracks

func (o *AudioInput) GetImposeTracks() []ImposeTrack

func (*AudioInput) GetSwapTrackURL

func (o *AudioInput) GetSwapTrackURL() *string

func (*AudioInput) GetType

func (o *AudioInput) GetType() *AudioInputType

type AudioInputType

type AudioInputType string

AudioInputType - Type of overlay (currently only supports 'audio').

const (
	AudioInputTypeAudio AudioInputType = "audio"
)

func (AudioInputType) ToPointer

func (e AudioInputType) ToPointer() *AudioInputType

func (*AudioInputType) UnmarshalJSON

func (e *AudioInputType) UnmarshalJSON(data []byte) error

type BadRequestError

type BadRequestError struct {
	// Displays the error code indicating the type of the error.
	Code *float64 `json:"code,omitempty"`
	// A descriptive message providing more details for the error.
	Message *string `json:"message,omitempty"`
	// A detailed explanation of the possible causes for the error.
	//
	Description *string `json:"description,omitempty"`
}

BadRequestError - Displays details about the reasons behind the request's failure.

func (*BadRequestError) GetCode

func (o *BadRequestError) GetCode() *float64

func (*BadRequestError) GetDescription

func (o *BadRequestError) GetDescription() *string

func (*BadRequestError) GetMessage

func (o *BadRequestError) GetMessage() *string

type CreateLiveStreamRequest

type CreateLiveStreamRequest struct {
	// Displays the result of the playback settings.
	PlaybackSettings PlaybackSettings `json:"playbackSettings"`
	// Displays the result of the input Media settings.
	InputMediaSettings InputMediaSettings `json:"inputMediaSettings"`
}

func (*CreateLiveStreamRequest) GetInputMediaSettings

func (o *CreateLiveStreamRequest) GetInputMediaSettings() InputMediaSettings

func (*CreateLiveStreamRequest) GetPlaybackSettings

func (o *CreateLiveStreamRequest) GetPlaybackSettings() PlaybackSettings

type CreateLiveStreamRequestMaxResolution

type CreateLiveStreamRequestMaxResolution string

CreateLiveStreamRequestMaxResolution - Max resolution can be used to control the maximum resolution your media is encoded, stored, and streamed at.

const (
	CreateLiveStreamRequestMaxResolutionOneThousandAndEightyp  CreateLiveStreamRequestMaxResolution = "1080p"
	CreateLiveStreamRequestMaxResolutionSevenHundredAndTwentyp CreateLiveStreamRequestMaxResolution = "720p"
	CreateLiveStreamRequestMaxResolutionFourHundredAndEightyp  CreateLiveStreamRequestMaxResolution = "480p"
)

func (CreateLiveStreamRequestMaxResolution) ToPointer

func (*CreateLiveStreamRequestMaxResolution) UnmarshalJSON

func (e *CreateLiveStreamRequestMaxResolution) UnmarshalJSON(data []byte) error

type CreateLiveStreamRequestMetadata

type CreateLiveStreamRequestMetadata struct {
}

CreateLiveStreamRequestMetadata - You can search for videos with specific key value pairs using metadata, when you tag a video in "key":"value"s pairs. Dynamic Metadata allows you to define a key that allows any value pair. You can have maximum of 255 characters and upto 10 entries are allowed.

type CreateMediaRequest

type CreateMediaRequest struct {
	Inputs []Input `json:"inputs"`
	// You can search for videos with specific key-value pairs using metadata, when you tag a video in "key" : "value" pairs. Dynamic Metadata allows you to define a key that allows any value pair. You can have a maximum of 255 characters and up to 10 entries are allowed.
	//
	Metadata *CreateMediaRequestMetadata `json:"metadata,omitempty"`
	// Generates subtitle files for audio/video files.
	//
	Subtitle *Subtitle `json:"subtitle,omitempty"`
	// Determines whether access to the streamed content is kept private or available to all.
	//
	AccessPolicy CreateMediaRequestAccessPolicy `json:"accessPolicy"`
	// “capped_4k": Generates an mp4 video file up to 4k resolution "audioOnly": Generates an m4a audio file of the media file "audioOnly,capped_4k": Generates both video and audio media files for offline viewing
	//
	Mp4Support *CreateMediaRequestMp4Support `json:"mp4Support,omitempty"`
	// The sourceAccess parameter determines whether the original media file is accessible. Set to true to enable access or false to restrict it
	SourceAccess *bool `json:"sourceAccess,omitempty"`
	// normalize volume of the audio track. This is available for pre-recorded content only.
	//
	OptimizeAudio *bool `default:"false" json:"optimizeAudio"`
	// The maximum resolution tier determines the highest quality your media will be available in.
	//
	MaxResolution *CreateMediaRequestMaxResolution `default:"1080p" json:"maxResolution"`
	Summary       *Summary                         `json:"summary,omitempty"`
	// Enable or disable the chapters feature for the media. Set to `true` to enable chapters or `false` to disable.
	//
	Chapters *bool `json:"chapters,omitempty"`
	// Enable or disable named entity extraction. Set to `true` to enable or `false` to disable.
	//
	NamedEntities      *bool                                 `json:"namedEntities,omitempty"`
	Moderation         *Moderation                           `json:"moderation,omitempty"`
	AccessRestrictions *CreateMediaRequestAccessRestrictions `json:"accessRestrictions,omitempty"`
}

func (*CreateMediaRequest) GetAccessPolicy

func (*CreateMediaRequest) GetAccessRestrictions

func (o *CreateMediaRequest) GetAccessRestrictions() *CreateMediaRequestAccessRestrictions

func (*CreateMediaRequest) GetChapters

func (o *CreateMediaRequest) GetChapters() *bool

func (*CreateMediaRequest) GetInputs

func (o *CreateMediaRequest) GetInputs() []Input

func (*CreateMediaRequest) GetMaxResolution

func (o *CreateMediaRequest) GetMaxResolution() *CreateMediaRequestMaxResolution

func (*CreateMediaRequest) GetMetadata

func (*CreateMediaRequest) GetModeration

func (o *CreateMediaRequest) GetModeration() *Moderation

func (*CreateMediaRequest) GetMp4Support

func (*CreateMediaRequest) GetNamedEntities

func (o *CreateMediaRequest) GetNamedEntities() *bool

func (*CreateMediaRequest) GetOptimizeAudio

func (o *CreateMediaRequest) GetOptimizeAudio() *bool

func (*CreateMediaRequest) GetSourceAccess

func (o *CreateMediaRequest) GetSourceAccess() *bool

func (*CreateMediaRequest) GetSubtitle

func (o *CreateMediaRequest) GetSubtitle() *Subtitle

func (*CreateMediaRequest) GetSummary

func (o *CreateMediaRequest) GetSummary() *Summary

func (CreateMediaRequest) MarshalJSON

func (c CreateMediaRequest) MarshalJSON() ([]byte, error)

func (*CreateMediaRequest) UnmarshalJSON

func (c *CreateMediaRequest) UnmarshalJSON(data []byte) error

type CreateMediaRequestAccessPolicy

type CreateMediaRequestAccessPolicy string

CreateMediaRequestAccessPolicy - Determines whether access to the streamed content is kept private or available to all.

const (
	CreateMediaRequestAccessPolicyPublic  CreateMediaRequestAccessPolicy = "public"
	CreateMediaRequestAccessPolicyPrivate CreateMediaRequestAccessPolicy = "private"
	CreateMediaRequestAccessPolicyDrm     CreateMediaRequestAccessPolicy = "drm"
)

func (CreateMediaRequestAccessPolicy) ToPointer

func (*CreateMediaRequestAccessPolicy) UnmarshalJSON

func (e *CreateMediaRequestAccessPolicy) UnmarshalJSON(data []byte) error

type CreateMediaRequestAccessRestrictions

type CreateMediaRequestAccessRestrictions struct {
	Domains    *CreateMediaRequestDomains    `json:"domains,omitempty"`
	UserAgents *CreateMediaRequestUserAgents `json:"userAgents,omitempty"`
}

func (*CreateMediaRequestAccessRestrictions) GetDomains

func (*CreateMediaRequestAccessRestrictions) GetUserAgents

type CreateMediaRequestDomains

type CreateMediaRequestDomains struct {
	// Specifies the default access policy for domains.
	// If set to `allow`, all domains are allowed access unless otherwise specified in the `deny` lists.
	// If set to `deny`, all domains are denied access unless otherwise specified in the `allow` lists.
	//
	DefaultPolicy *CreateMediaRequestDomainsDefaultPolicy `json:"defaultPolicy,omitempty"`
	// A list of domain names or patterns that are explicitly allowed access.
	// This list is only effective when the `defaultPolicy` is set to `deny`.
	//
	Allow []string `json:"allow,omitempty"`
	// A list of domain names or patterns that are explicitly denied access.
	// This list is only effective when the `defaultPolicy` is set to `allow`.
	//
	Deny []string `json:"deny,omitempty"`
}

func (*CreateMediaRequestDomains) GetAllow

func (o *CreateMediaRequestDomains) GetAllow() []string

func (*CreateMediaRequestDomains) GetDefaultPolicy

func (*CreateMediaRequestDomains) GetDeny

func (o *CreateMediaRequestDomains) GetDeny() []string

type CreateMediaRequestDomainsDefaultPolicy

type CreateMediaRequestDomainsDefaultPolicy string

CreateMediaRequestDomainsDefaultPolicy - Specifies the default access policy for domains. If set to `allow`, all domains are allowed access unless otherwise specified in the `deny` lists. If set to `deny`, all domains are denied access unless otherwise specified in the `allow` lists.

const (
	CreateMediaRequestDomainsDefaultPolicyAllow CreateMediaRequestDomainsDefaultPolicy = "allow"
	CreateMediaRequestDomainsDefaultPolicyDeny  CreateMediaRequestDomainsDefaultPolicy = "deny"
)

func (CreateMediaRequestDomainsDefaultPolicy) ToPointer

func (*CreateMediaRequestDomainsDefaultPolicy) UnmarshalJSON

func (e *CreateMediaRequestDomainsDefaultPolicy) UnmarshalJSON(data []byte) error

type CreateMediaRequestLanguageCode

type CreateMediaRequestLanguageCode string

CreateMediaRequestLanguageCode - Language codes are concise, standardized symbols that denote languages, utilizing either two or three characters for identification. The language code must be compliant with the BCP 47 standard to ensure compatibility. (for text only).

const (
	CreateMediaRequestLanguageCodeEn CreateMediaRequestLanguageCode = "en"
	CreateMediaRequestLanguageCodeIt CreateMediaRequestLanguageCode = "it"
	CreateMediaRequestLanguageCodePl CreateMediaRequestLanguageCode = "pl"
	CreateMediaRequestLanguageCodeEs CreateMediaRequestLanguageCode = "es"
	CreateMediaRequestLanguageCodeFr CreateMediaRequestLanguageCode = "fr"
	CreateMediaRequestLanguageCodeRu CreateMediaRequestLanguageCode = "ru"
	CreateMediaRequestLanguageCodeNl CreateMediaRequestLanguageCode = "nl"
)

func (CreateMediaRequestLanguageCode) ToPointer

func (*CreateMediaRequestLanguageCode) UnmarshalJSON

func (e *CreateMediaRequestLanguageCode) UnmarshalJSON(data []byte) error

type CreateMediaRequestMaxResolution

type CreateMediaRequestMaxResolution string

CreateMediaRequestMaxResolution - The maximum resolution tier determines the highest quality your media will be available in.

const (
	CreateMediaRequestMaxResolutionTwoThousandOneHundredAndSixtyp  CreateMediaRequestMaxResolution = "2160p"
	CreateMediaRequestMaxResolutionOneThousandFourHundredAndFortyp CreateMediaRequestMaxResolution = "1440p"
	CreateMediaRequestMaxResolutionOneThousandAndEightyp           CreateMediaRequestMaxResolution = "1080p"
	CreateMediaRequestMaxResolutionSevenHundredAndTwentyp          CreateMediaRequestMaxResolution = "720p"
	CreateMediaRequestMaxResolutionFourHundredAndEightyp           CreateMediaRequestMaxResolution = "480p"
	CreateMediaRequestMaxResolutionThreeHundredAndSixtyp           CreateMediaRequestMaxResolution = "360p"
)

func (CreateMediaRequestMaxResolution) ToPointer

func (*CreateMediaRequestMaxResolution) UnmarshalJSON

func (e *CreateMediaRequestMaxResolution) UnmarshalJSON(data []byte) error

type CreateMediaRequestMetadata

type CreateMediaRequestMetadata struct {
}

CreateMediaRequestMetadata - You can search for videos with specific key-value pairs using metadata, when you tag a video in "key" : "value" pairs. Dynamic Metadata allows you to define a key that allows any value pair. You can have a maximum of 255 characters and up to 10 entries are allowed.

type CreateMediaRequestMp4Support

type CreateMediaRequestMp4Support string

CreateMediaRequestMp4Support - “capped_4k": Generates an mp4 video file up to 4k resolution "audioOnly": Generates an m4a audio file of the media file "audioOnly,capped_4k": Generates both video and audio media files for offline viewing

const (
	CreateMediaRequestMp4SupportCapped4k          CreateMediaRequestMp4Support = "capped_4k"
	CreateMediaRequestMp4SupportAudioOnly         CreateMediaRequestMp4Support = "audioOnly"
	CreateMediaRequestMp4SupportAudioOnlyCapped4k CreateMediaRequestMp4Support = "audioOnly,capped_4k"
)

func (CreateMediaRequestMp4Support) ToPointer

func (*CreateMediaRequestMp4Support) UnmarshalJSON

func (e *CreateMediaRequestMp4Support) UnmarshalJSON(data []byte) error

type CreateMediaRequestType

type CreateMediaRequestType string

CreateMediaRequestType - Defines the type of input. Possible values include video, audio, av.

const (
	CreateMediaRequestTypeVideo CreateMediaRequestType = "video"
	CreateMediaRequestTypeAudio CreateMediaRequestType = "audio"
	CreateMediaRequestTypeAv    CreateMediaRequestType = "av"
)

func (CreateMediaRequestType) ToPointer

func (*CreateMediaRequestType) UnmarshalJSON

func (e *CreateMediaRequestType) UnmarshalJSON(data []byte) error

type CreateMediaRequestUserAgents

type CreateMediaRequestUserAgents struct {
	// Specifies the default access policy for user agents (browsers, bots, etc.).
	// If set to `allow`, all user agents are allowed access unless otherwise specified in the `deny` lists.
	// If set to `deny`, all user agents are denied access unless otherwise specified in the `allow` lists.
	//
	DefaultPolicy *CreateMediaRequestUserAgentsDefaultPolicy `json:"defaultPolicy,omitempty"`
	// A list of user agents (identified by string names or patterns) that are explicitly allowed access.
	// This list is only effective when the `defaultPolicy` is set to `deny`.
	//
	Allow []string `json:"allow,omitempty"`
	// A list of user agents (identified by string names or patterns) that are explicitly denied access.
	// This list is only effective when the `defaultPolicy` is set to `allow`.
	//
	Deny []string `json:"deny,omitempty"`
}

func (*CreateMediaRequestUserAgents) GetAllow

func (o *CreateMediaRequestUserAgents) GetAllow() []string

func (*CreateMediaRequestUserAgents) GetDefaultPolicy

func (*CreateMediaRequestUserAgents) GetDeny

func (o *CreateMediaRequestUserAgents) GetDeny() []string

type CreateMediaRequestUserAgentsDefaultPolicy

type CreateMediaRequestUserAgentsDefaultPolicy string

CreateMediaRequestUserAgentsDefaultPolicy - Specifies the default access policy for user agents (browsers, bots, etc.). If set to `allow`, all user agents are allowed access unless otherwise specified in the `deny` lists. If set to `deny`, all user agents are denied access unless otherwise specified in the `allow` lists.

const (
	CreateMediaRequestUserAgentsDefaultPolicyAllow CreateMediaRequestUserAgentsDefaultPolicy = "allow"
	CreateMediaRequestUserAgentsDefaultPolicyDeny  CreateMediaRequestUserAgentsDefaultPolicy = "deny"
)

func (CreateMediaRequestUserAgentsDefaultPolicy) ToPointer

func (*CreateMediaRequestUserAgentsDefaultPolicy) UnmarshalJSON

func (e *CreateMediaRequestUserAgentsDefaultPolicy) UnmarshalJSON(data []byte) error

type CreateMediaResponse

type CreateMediaResponse struct {
	// The Media is assigned a universal unique identifier, which can contain a maximum of 255 characters.
	ID *string `json:"id,omitempty"`
	// FastPix allows for a free trial. Create as many media files as you like during the trial period. Remember, each clip can only be 10 seconds long and will be deleted after 24 hours. Also, all trial content will have the FastPix logo watermark.
	//
	Trial *bool `default:"true" json:"trial"`
	// Determines the media's status, which can be one of the possible values.
	Status *string `json:"status,omitempty"`
	// Time the media was created, defined as a localDateTime (UTC Time).
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	// Time the media was updated, defined as a localDateTime (UTC Time).
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	// A collection of Playback ID objects utilized for crafting HLS playback URLs.
	PlaybackIds []PlaybackID `json:"playbackIds,omitempty"`
	// You can search for videos with specific key value pairs using metadata, when you tag a video in "key" : "value" pairs. Dynamic Metadata allows you to define a key that allows any value pair. You can have maximum of 255 characters and upto 10 entries are allowed.
	Metadata *CreateMediaResponseMetadata `json:"metadata,omitempty"`
	// The maximum resolution tier determines the highest quality your media will be available in.
	MaxResolution *CreateMediaResponseMaxResolution `default:"1080p" json:"maxResolution"`
}

func (*CreateMediaResponse) GetCreatedAt

func (o *CreateMediaResponse) GetCreatedAt() *time.Time

func (*CreateMediaResponse) GetID

func (o *CreateMediaResponse) GetID() *string

func (*CreateMediaResponse) GetMaxResolution

func (*CreateMediaResponse) GetMetadata

func (*CreateMediaResponse) GetPlaybackIds

func (o *CreateMediaResponse) GetPlaybackIds() []PlaybackID

func (*CreateMediaResponse) GetStatus

func (o *CreateMediaResponse) GetStatus() *string

func (*CreateMediaResponse) GetTrial

func (o *CreateMediaResponse) GetTrial() *bool

func (*CreateMediaResponse) GetUpdatedAt

func (o *CreateMediaResponse) GetUpdatedAt() *time.Time

func (CreateMediaResponse) MarshalJSON

func (c CreateMediaResponse) MarshalJSON() ([]byte, error)

func (*CreateMediaResponse) UnmarshalJSON

func (c *CreateMediaResponse) UnmarshalJSON(data []byte) error

type CreateMediaResponseMaxResolution

type CreateMediaResponseMaxResolution string

CreateMediaResponseMaxResolution - The maximum resolution tier determines the highest quality your media will be available in.

const (
	CreateMediaResponseMaxResolutionTwoThousandOneHundredAndSixtyp  CreateMediaResponseMaxResolution = "2160p"
	CreateMediaResponseMaxResolutionOneThousandFourHundredAndFortyp CreateMediaResponseMaxResolution = "1440p"
	CreateMediaResponseMaxResolutionOneThousandAndEightyp           CreateMediaResponseMaxResolution = "1080p"
	CreateMediaResponseMaxResolutionSevenHundredAndTwentyp          CreateMediaResponseMaxResolution = "720p"
	CreateMediaResponseMaxResolutionFourHundredAndEightyp           CreateMediaResponseMaxResolution = "480p"
	CreateMediaResponseMaxResolutionThreeHundredAndSixtyp           CreateMediaResponseMaxResolution = "360p"
)

func (CreateMediaResponseMaxResolution) ToPointer

func (*CreateMediaResponseMaxResolution) UnmarshalJSON

func (e *CreateMediaResponseMaxResolution) UnmarshalJSON(data []byte) error

type CreateMediaResponseMetadata

type CreateMediaResponseMetadata struct {
}

CreateMediaResponseMetadata - You can search for videos with specific key value pairs using metadata, when you tag a video in "key" : "value" pairs. Dynamic Metadata allows you to define a key that allows any value pair. You can have maximum of 255 characters and upto 10 entries are allowed.

type DirectUpload

type DirectUpload struct {
	// When creating the upload, FastPix assigns a universally unique identifier with a maximum length of 255 characters.
	ID *string `json:"id,omitempty"`
	// When creating the media, FastPix assigns a universally unique identifier with a maximum length of 255 characters.
	MediaID *string `json:"mediaId,omitempty"`
	// Determines the media's status, which can be one of the possible values.
	Status *string `json:"status,omitempty"`
	// The url hosts the media file for FastPix, which needs to be download to use further.  It supports formats like MP3, MP4, MOV, MKV, or TS, and includes text tracks for subtitles/CC (SRT file/VTT file). While FastPix can handle various audio and video formats and codecs, using standard inputs can help with optimal processing speed.
	URL *string `json:"url,omitempty"`
	// The duration set for the validity of the upload URL. If the upload isn't completed within this timeframe, it's marked as timed out.
	//
	Timeout *float64 `default:"14400" json:"timeout"`
	// Upload media directly from a device using the url name or enter '*' to allow all.
	CorsOrigin        *string               `json:"corsOrigin,omitempty"`
	PushMediaSettings *DirectUploadResponse `json:"pushMediaSettings,omitempty"`
}

DirectUpload - Displays the result of the request.

func (*DirectUpload) GetCorsOrigin

func (o *DirectUpload) GetCorsOrigin() *string

func (*DirectUpload) GetID

func (o *DirectUpload) GetID() *string

func (*DirectUpload) GetMediaID

func (o *DirectUpload) GetMediaID() *string

func (*DirectUpload) GetPushMediaSettings

func (o *DirectUpload) GetPushMediaSettings() *DirectUploadResponse

func (*DirectUpload) GetStatus

func (o *DirectUpload) GetStatus() *string

func (*DirectUpload) GetTimeout

func (o *DirectUpload) GetTimeout() *float64

func (*DirectUpload) GetURL

func (o *DirectUpload) GetURL() *string

func (DirectUpload) MarshalJSON

func (d DirectUpload) MarshalJSON() ([]byte, error)

func (*DirectUpload) UnmarshalJSON

func (d *DirectUpload) UnmarshalJSON(data []byte) error

type DirectUploadResponse

type DirectUploadResponse struct {
	PlaybackIds []PlaybackID `json:"playbackIds,omitempty"`
	// You can search for videos with specific key value pairs using metadata, when you tag a video in "key" : "value" pairs. Dynamic Metadata allows you to define a key that allows any value pair. You can have maximum of 255 characters and upto 10 entries are allowed.
	Metadata *DirectUploadResponseMetadata `json:"metadata,omitempty"`
}

func (*DirectUploadResponse) GetMetadata

func (*DirectUploadResponse) GetPlaybackIds

func (o *DirectUploadResponse) GetPlaybackIds() []PlaybackID

type DirectUploadResponseMetadata

type DirectUploadResponseMetadata struct {
}

DirectUploadResponseMetadata - You can search for videos with specific key value pairs using metadata, when you tag a video in "key" : "value" pairs. Dynamic Metadata allows you to define a key that allows any value pair. You can have maximum of 255 characters and upto 10 entries are allowed.

type Field

type Field struct {
	// Displays the specific field associated with the error.
	Field *string `json:"field,omitempty"`
	// A descriptive message providing more details for the error
	Message *string `json:"message,omitempty"`
}

func (*Field) GetField

func (o *Field) GetField() *string

func (*Field) GetMessage

func (o *Field) GetMessage() *string

type ForbiddenError

type ForbiddenError struct {
	// Displays the error code indicating the type of the error.
	Code *int64 `json:"code,omitempty"`
	// A descriptive message providing more details for the error.
	Message *string `json:"message,omitempty"`
	// A detailed explanation of the possible causes for the error.
	//
	Description *string `json:"description,omitempty"`
}

ForbiddenError - Displays details about the reasons behind the request's failure.

func (*ForbiddenError) GetCode

func (o *ForbiddenError) GetCode() *int64

func (*ForbiddenError) GetDescription

func (o *ForbiddenError) GetDescription() *string

func (*ForbiddenError) GetMessage

func (o *ForbiddenError) GetMessage() *string

type GetCreateLiveStreamResponseDTO

type GetCreateLiveStreamResponseDTO struct {
	// Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
	StreamID *string `json:"streamId,omitempty"`
	// A unique stream key is generated for streaming, allowing the user to start streaming on any third-party platform using this key.
	StreamKey *string `json:"streamKey,omitempty"`
	// A secret used for securing the SRT stream. This ensures that only authorized users can access the stream.
	SrtSecret *string `json:"srtSecret,omitempty"`
	// FastPix allows for a to trial the live stream for free. The duration of trial streams is five minutes. After five minutes of activity, the trial stream is turned off, and the recorded asset is removed after a day.
	Trial *bool `json:"trial,omitempty"`
	// The current live stream status can be one of four values:Idle, Preparing, Active or Disabled.The Idle status signifies that there isn't a broadcast in progress.The preparing status indicates that the stream is getting prepared. while, the Active status indicates that a broadcast is currently in progress. The Disabled status means that no more RTMP streams can be published.
	Status *string `json:"status,omitempty"`
	// Max resolution can be used to control the maximum resolution your media is encoded, stored, and streamed at.
	MaxResolution *string `json:"maxResolution,omitempty"`
	// The maximum duration in seconds that a live stream can have before it ends the stream.
	MaxDuration *int64 `json:"maxDuration,omitempty"`
	// It is the moment when the stream was created Time the media was generated, defined as a localDateTime (UTC Time).
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	// In case the software streaming the live, get disrupted for any reason and get disconnect from FastPix, the reconnect window specifies the waiting time span of FastPix will wait before ending the stream. Before starting the stream, you can set the reconnect window time set which is up to 1800 seconds.
	ReconnectWindow *int64 `default:"60" json:"reconnectWindow"`
	// When set to true, the livestream will be recorded and stored for later viewing purposes. If set to false, the livestream will not be recorded.
	EnableRecording *bool `json:"enableRecording,omitempty"`
	// Determines whether the recorded stream should be publicly accessible or private in Live to VOD (Video on Demand).
	MediaPolicy *string `json:"mediaPolicy,omitempty"`
	// You can search for videos with specific key value pairs using metadata, when you tag a video in "key":"value"s pairs. Dynamic Metadata allows you to define a key that allows any value pair. You can have maximum of 255 characters and upto 10 entries are allowed.
	Metadata *GetCreateLiveStreamResponseDTOMetadata `json:"metadata,omitempty"`
	// A collection of Playback ID objects utilized for crafting HLS playback urls.
	PlaybackID []PlaybackIds `json:"playbackId,omitempty"`
	// This object contains the livestream playback response details for SRT Protocol.
	SrtPlaybackResponse *GetCreateLiveStreamResponseDTOSrtPlaybackResponse `json:"srtPlaybackResponse,omitempty"`
}

GetCreateLiveStreamResponseDTO - Displays the result of the request.

func (*GetCreateLiveStreamResponseDTO) GetCreatedAt

func (o *GetCreateLiveStreamResponseDTO) GetCreatedAt() *time.Time

func (*GetCreateLiveStreamResponseDTO) GetEnableRecording

func (o *GetCreateLiveStreamResponseDTO) GetEnableRecording() *bool

func (*GetCreateLiveStreamResponseDTO) GetMaxDuration

func (o *GetCreateLiveStreamResponseDTO) GetMaxDuration() *int64

func (*GetCreateLiveStreamResponseDTO) GetMaxResolution

func (o *GetCreateLiveStreamResponseDTO) GetMaxResolution() *string

func (*GetCreateLiveStreamResponseDTO) GetMediaPolicy

func (o *GetCreateLiveStreamResponseDTO) GetMediaPolicy() *string

func (*GetCreateLiveStreamResponseDTO) GetMetadata

func (*GetCreateLiveStreamResponseDTO) GetPlaybackID

func (o *GetCreateLiveStreamResponseDTO) GetPlaybackID() []PlaybackIds

func (*GetCreateLiveStreamResponseDTO) GetReconnectWindow

func (o *GetCreateLiveStreamResponseDTO) GetReconnectWindow() *int64

func (*GetCreateLiveStreamResponseDTO) GetSrtPlaybackResponse

func (*GetCreateLiveStreamResponseDTO) GetSrtSecret

func (o *GetCreateLiveStreamResponseDTO) GetSrtSecret() *string

func (*GetCreateLiveStreamResponseDTO) GetStatus

func (o *GetCreateLiveStreamResponseDTO) GetStatus() *string

func (*GetCreateLiveStreamResponseDTO) GetStreamID

func (o *GetCreateLiveStreamResponseDTO) GetStreamID() *string

func (*GetCreateLiveStreamResponseDTO) GetStreamKey

func (o *GetCreateLiveStreamResponseDTO) GetStreamKey() *string

func (*GetCreateLiveStreamResponseDTO) GetTrial

func (o *GetCreateLiveStreamResponseDTO) GetTrial() *bool

func (GetCreateLiveStreamResponseDTO) MarshalJSON

func (g GetCreateLiveStreamResponseDTO) MarshalJSON() ([]byte, error)

func (*GetCreateLiveStreamResponseDTO) UnmarshalJSON

func (g *GetCreateLiveStreamResponseDTO) UnmarshalJSON(data []byte) error

type GetCreateLiveStreamResponseDTOMetadata

type GetCreateLiveStreamResponseDTOMetadata struct {
}

GetCreateLiveStreamResponseDTOMetadata - You can search for videos with specific key value pairs using metadata, when you tag a video in "key":"value"s pairs. Dynamic Metadata allows you to define a key that allows any value pair. You can have maximum of 255 characters and upto 10 entries are allowed.

type GetCreateLiveStreamResponseDTOSrtPlaybackResponse

type GetCreateLiveStreamResponseDTOSrtPlaybackResponse struct {
	// A unique identifier for the SRT playback stream. This ID is used to distinguish between different playback streams.
	SrtPlaybackStreamID *string `json:"srtPlaybackStreamId,omitempty"`
	// A playback secret used for securing the SRT playback stream. This ensures that only authorized users can access the playback.
	SrtPlaybackSecret *string `json:"srtPlaybackSecret,omitempty"`
}

GetCreateLiveStreamResponseDTOSrtPlaybackResponse - This object contains the livestream playback response details for SRT Protocol.

func (*GetCreateLiveStreamResponseDTOSrtPlaybackResponse) GetSrtPlaybackSecret

func (o *GetCreateLiveStreamResponseDTOSrtPlaybackResponse) GetSrtPlaybackSecret() *string

func (*GetCreateLiveStreamResponseDTOSrtPlaybackResponse) GetSrtPlaybackStreamID

func (o *GetCreateLiveStreamResponseDTOSrtPlaybackResponse) GetSrtPlaybackStreamID() *string

type GetStreamsResponse

type GetStreamsResponse struct {
	// It demonstrates whether the request is successful or not.
	Success *bool `json:"success,omitempty"`
	// Displays the result of the request.
	Data []GetCreateLiveStreamResponseDTO `json:"data,omitempty"`
	// Pagination organizes content into pages for better readability and navigation.
	Pagination *Pagination `json:"pagination,omitempty"`
}

GetStreamsResponse - Displays the result of the request.

func (*GetStreamsResponse) GetData

func (*GetStreamsResponse) GetPagination

func (o *GetStreamsResponse) GetPagination() *Pagination

func (*GetStreamsResponse) GetSuccess

func (o *GetStreamsResponse) GetSuccess() *bool

type HTTPMetadata

type HTTPMetadata struct {
	// Raw HTTP response; suitable for custom response parsing
	Response *http.Response `json:"-"`
	// Raw HTTP request; suitable for debugging
	Request *http.Request `json:"-"`
}

func (*HTTPMetadata) GetRequest

func (o *HTTPMetadata) GetRequest() *http.Request

func (*HTTPMetadata) GetResponse

func (o *HTTPMetadata) GetResponse() *http.Response

type ImposeTrack

type ImposeTrack struct {
	// URL of the audio track to impose on the video.
	URL *string `json:"url,omitempty"`
	// Start time (in seconds) of the imposed audio in the video.
	StartTime *int64 `json:"startTime,omitempty"`
	// End time (in seconds) of the imposed audio in the video.
	EndTime *int64 `json:"endTime,omitempty"`
	// Level of fade-in effect (in seconds) at the start of the imposed audio.
	FadeInLevel *int64 `json:"fadeInLevel,omitempty"`
	// Level of fade-out effect (in seconds) at the end of the imposed audio.
	FadeOutLevel *int64 `json:"fadeOutLevel,omitempty"`
}

func (*ImposeTrack) GetEndTime

func (o *ImposeTrack) GetEndTime() *int64

func (*ImposeTrack) GetFadeInLevel

func (o *ImposeTrack) GetFadeInLevel() *int64

func (*ImposeTrack) GetFadeOutLevel

func (o *ImposeTrack) GetFadeOutLevel() *int64

func (*ImposeTrack) GetStartTime

func (o *ImposeTrack) GetStartTime() *int64

func (*ImposeTrack) GetURL

func (o *ImposeTrack) GetURL() *string

type Input

type Input struct {
	VideoInput     *VideoInput     `queryParam:"inline"`
	WatermarkInput *WatermarkInput `queryParam:"inline"`
	AudioInput     *AudioInput     `queryParam:"inline"`
	SubtitleInput  *SubtitleInput  `queryParam:"inline"`

	Type InputType
}

func CreateInputAudioInput

func CreateInputAudioInput(audioInput AudioInput) Input

func CreateInputSubtitleInput

func CreateInputSubtitleInput(subtitleInput SubtitleInput) Input

func CreateInputVideoInput

func CreateInputVideoInput(videoInput VideoInput) Input

func CreateInputWatermarkInput

func CreateInputWatermarkInput(watermarkInput WatermarkInput) Input

func (Input) MarshalJSON

func (u Input) MarshalJSON() ([]byte, error)

func (*Input) UnmarshalJSON

func (u *Input) UnmarshalJSON(data []byte) error

type InputMediaSettings

type InputMediaSettings struct {
	// Max resolution can be used to control the maximum resolution your media is encoded, stored, and streamed at.
	MaxResolution *CreateLiveStreamRequestMaxResolution `default:"1080p" json:"maxResolution"`
	// In case the software streaming the live, get disrupted for any reason and get disconnect from FastPix, the reconnect window specifies the waiting time span of FastPix will wait before ending the stream. Before starting the stream, you can set the reconnect window time set which is up to 1800 seconds.
	ReconnectWindow *int64 `default:"60" json:"reconnectWindow"`
	// Determines whether the recorded stream should be publicly accessible or private in Live to VOD (Video on Demand).
	MediaPolicy *MediaPolicy `default:"public" json:"mediaPolicy"`
	// You can search for videos with specific key value pairs using metadata, when you tag a video in "key":"value"s pairs. Dynamic Metadata allows you to define a key that allows any value pair. You can have maximum of 255 characters and upto 10 entries are allowed.
	Metadata *CreateLiveStreamRequestMetadata `json:"metadata,omitempty"`
}

InputMediaSettings - Displays the result of the input Media settings.

func (*InputMediaSettings) GetMaxResolution

func (*InputMediaSettings) GetMediaPolicy

func (o *InputMediaSettings) GetMediaPolicy() *MediaPolicy

func (*InputMediaSettings) GetMetadata

func (*InputMediaSettings) GetReconnectWindow

func (o *InputMediaSettings) GetReconnectWindow() *int64

func (InputMediaSettings) MarshalJSON

func (i InputMediaSettings) MarshalJSON() ([]byte, error)

func (*InputMediaSettings) UnmarshalJSON

func (i *InputMediaSettings) UnmarshalJSON(data []byte) error

type InputType

type InputType string
const (
	InputTypeVideoInput     InputType = "VideoInput"
	InputTypeWatermarkInput InputType = "WatermarkInput"
	InputTypeAudioInput     InputType = "AudioInput"
	InputTypeSubtitleInput  InputType = "SubtitleInput"
)

type InvalidPermissionError

type InvalidPermissionError struct {
	// Displays the error code indicating the type of the error.
	Code *int64 `json:"code,omitempty"`
	// A descriptive message providing more details for the error.
	Message *string `json:"message,omitempty"`
	// A detailed explanation of the possible causes for the error.
	//
	Description *string `json:"description,omitempty"`
}

InvalidPermissionError - Displays details about the reasons behind the request's failure.

func (*InvalidPermissionError) GetCode

func (o *InvalidPermissionError) GetCode() *int64

func (*InvalidPermissionError) GetDescription

func (o *InvalidPermissionError) GetDescription() *string

func (*InvalidPermissionError) GetMessage

func (o *InvalidPermissionError) GetMessage() *string

type LiveStreamDeleteResponse

type LiveStreamDeleteResponse struct {
	// It demonstrates whether the request is successful or not.
	Success *bool `json:"success,omitempty"`
}

func (*LiveStreamDeleteResponse) GetSuccess

func (o *LiveStreamDeleteResponse) GetSuccess() *bool

type LiveStreamResponseDTO

type LiveStreamResponseDTO struct {
	// It demonstrates whether the request is successful or not.
	Success *bool `json:"success,omitempty"`
	// Displays the result of the request.
	Data *GetCreateLiveStreamResponseDTO `json:"data,omitempty"`
}

LiveStreamResponseDTO - Displays the result of the request.

func (*LiveStreamResponseDTO) GetData

func (*LiveStreamResponseDTO) GetSuccess

func (o *LiveStreamResponseDTO) GetSuccess() *bool

type LivestreamgetResponse

type LivestreamgetResponse struct {
	// It demonstrates whether the request is successful or not.
	Success *bool `json:"success,omitempty"`
	// Displays the result of the request.
	Data *GetCreateLiveStreamResponseDTO `json:"data,omitempty"`
}

LivestreamgetResponse - Displays the result of the request.

func (*LivestreamgetResponse) GetData

func (*LivestreamgetResponse) GetSuccess

func (o *LivestreamgetResponse) GetSuccess() *bool

type Media

type Media struct {
	// A video thumbnail is a still image that acts as the preview image for your video.
	Thumbnail *string `json:"thumbnail,omitempty"`
	// When creating the media, FastPix assigns a universally unique identifier with a maximum length of 255 characters.
	ID *string `json:"id,omitempty"`
	// A unique identifier is generated by FastPix for the workspace.
	WorkspaceID *string `json:"workspaceId,omitempty"`
	// You can search for videos with specific key value pairs using metadata, when you tag a video in "key" : "value" pairs. Dynamic Metadata allows you to define a key that allows any value pair. You can have maximum of 255 characters and upto 10 entries are allowed.
	Metadata *MediaMetadata `json:"metadata,omitempty"`
	// The maximum resolution specified by the user for the media.
	MaxResolution *MediaMaxResolution `default:"1080p" json:"maxResolution"`
	// The actual resolution of the uploaded media. This represents the native quality of the source media.
	SourceResolution *SourceResolution `default:"1080p" json:"sourceResolution"`
	// Determines the media's status, which can be one of the possible values.
	Status *string `json:"status,omitempty"`
	// Determines the type of MP4 support for the media.   - **none**: Disables MP4 support.   - **capped_4k**: Enables MP4 downloads with resolutions up to 4K.   - **audioOnly**: Provides an MP4 stream containing only the audio.   - **audioOnly,capped_4k**: Enables both MP4 video downloads (up to 4K) and an audio-only stream.
	Mp4Support *MediaMp4Support `json:"mp4Support,omitempty"`
	// The sourceAccess parameter determines whether the original media file is accessible. Set to true to enable access or false to restrict it
	SourceAccess *bool `json:"sourceAccess,omitempty"`
	// A collection of Playback ID objects utilized for crafting HLS playback URLs.
	PlaybackIds []PlaybackID `json:"playbackIds,omitempty"`
	// A media consists of different media tracks, like video, audio, and subtitle, all combined.
	Tracks []Track `json:"tracks,omitempty"`
	// The time span of the media, measured in seconds with a maximum allowable duration of 12 hours per individual media.
	Duration *string `json:"duration,omitempty"`
	// Frame rate quantifies the speed at which frames are displayed per second. It represents the range of frames available for a specific track. If the frame rate of the input file is indeterminable, it will be indicated by a value of -1.
	FrameRate *string `json:"frameRate,omitempty"`
	// The aspect ratio of a video is a value that describes the relative shape of a video based on its width and height.
	AspectRatio *string `json:"aspectRatio,omitempty"`
	// Time the media was created, defined as a localDateTime (UTC Time).
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	// Time the media was updated, defined as a localDateTime (UTC Time).
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
}

func (*Media) GetAspectRatio

func (o *Media) GetAspectRatio() *string

func (*Media) GetCreatedAt

func (o *Media) GetCreatedAt() *time.Time

func (*Media) GetDuration

func (o *Media) GetDuration() *string

func (*Media) GetFrameRate

func (o *Media) GetFrameRate() *string

func (*Media) GetID

func (o *Media) GetID() *string

func (*Media) GetMaxResolution

func (o *Media) GetMaxResolution() *MediaMaxResolution

func (*Media) GetMetadata

func (o *Media) GetMetadata() *MediaMetadata

func (*Media) GetMp4Support

func (o *Media) GetMp4Support() *MediaMp4Support

func (*Media) GetPlaybackIds

func (o *Media) GetPlaybackIds() []PlaybackID

func (*Media) GetSourceAccess

func (o *Media) GetSourceAccess() *bool

func (*Media) GetSourceResolution

func (o *Media) GetSourceResolution() *SourceResolution

func (*Media) GetStatus

func (o *Media) GetStatus() *string

func (*Media) GetThumbnail

func (o *Media) GetThumbnail() *string

func (*Media) GetTracks

func (o *Media) GetTracks() []Track

func (*Media) GetUpdatedAt

func (o *Media) GetUpdatedAt() *time.Time

func (*Media) GetWorkspaceID

func (o *Media) GetWorkspaceID() *string

func (Media) MarshalJSON

func (m Media) MarshalJSON() ([]byte, error)

func (*Media) UnmarshalJSON

func (m *Media) UnmarshalJSON(data []byte) error

type MediaMaxResolution

type MediaMaxResolution string

MediaMaxResolution - The maximum resolution specified by the user for the media.

const (
	MediaMaxResolutionTwoThousandOneHundredAndSixtyp  MediaMaxResolution = "2160p"
	MediaMaxResolutionOneThousandFourHundredAndFortyp MediaMaxResolution = "1440p"
	MediaMaxResolutionOneThousandAndEightyp           MediaMaxResolution = "1080p"
	MediaMaxResolutionSevenHundredAndTwentyp          MediaMaxResolution = "720p"
	MediaMaxResolutionFourHundredAndEightyp           MediaMaxResolution = "480p"
	MediaMaxResolutionThreeHundredAndSixtyp           MediaMaxResolution = "360p"
)

func (MediaMaxResolution) ToPointer

func (e MediaMaxResolution) ToPointer() *MediaMaxResolution

func (*MediaMaxResolution) UnmarshalJSON

func (e *MediaMaxResolution) UnmarshalJSON(data []byte) error

type MediaMetadata

type MediaMetadata struct {
}

MediaMetadata - You can search for videos with specific key value pairs using metadata, when you tag a video in "key" : "value" pairs. Dynamic Metadata allows you to define a key that allows any value pair. You can have maximum of 255 characters and upto 10 entries are allowed.

type MediaMp4Support

type MediaMp4Support string

MediaMp4Support - Determines the type of MP4 support for the media. - **none**: Disables MP4 support. - **capped_4k**: Enables MP4 downloads with resolutions up to 4K. - **audioOnly**: Provides an MP4 stream containing only the audio. - **audioOnly,capped_4k**: Enables both MP4 video downloads (up to 4K) and an audio-only stream.

const (
	MediaMp4SupportNone              MediaMp4Support = "none"
	MediaMp4SupportCapped4k          MediaMp4Support = "capped_4k"
	MediaMp4SupportAudioOnly         MediaMp4Support = "audioOnly"
	MediaMp4SupportAudioOnlyCapped4k MediaMp4Support = "audioOnly,capped_4k"
)

func (MediaMp4Support) ToPointer

func (e MediaMp4Support) ToPointer() *MediaMp4Support

func (*MediaMp4Support) UnmarshalJSON

func (e *MediaMp4Support) UnmarshalJSON(data []byte) error

type MediaNotFoundError

type MediaNotFoundError struct {
	// Displays the error code indicating the type of the error.
	Code *float64 `json:"code,omitempty"`
	// A descriptive message providing more details for the error.
	Message *string `json:"message,omitempty"`
	// A detailed explanation of the possible causes for the error.
	//
	Description *string `json:"description,omitempty"`
}

MediaNotFoundError - Displays details about the reasons behind the request's failure.

func (*MediaNotFoundError) GetCode

func (o *MediaNotFoundError) GetCode() *float64

func (*MediaNotFoundError) GetDescription

func (o *MediaNotFoundError) GetDescription() *string

func (*MediaNotFoundError) GetMessage

func (o *MediaNotFoundError) GetMessage() *string

type MediaOrPlaybackNotFoundError

type MediaOrPlaybackNotFoundError struct {
	// Displays the error code indicating the type of the error.
	Code *float64 `json:"code,omitempty"`
	// A descriptive message providing more details for the error.
	Message *string `json:"message,omitempty"`
	// A detailed explanation of the possible causes for the error.
	//
	Description *string `json:"description,omitempty"`
}

MediaOrPlaybackNotFoundError - Displays details about the reasons behind the request's failure.

func (*MediaOrPlaybackNotFoundError) GetCode

func (o *MediaOrPlaybackNotFoundError) GetCode() *float64

func (*MediaOrPlaybackNotFoundError) GetDescription

func (o *MediaOrPlaybackNotFoundError) GetDescription() *string

func (*MediaOrPlaybackNotFoundError) GetMessage

func (o *MediaOrPlaybackNotFoundError) GetMessage() *string

type MediaPolicy

type MediaPolicy string

MediaPolicy - Determines whether the recorded stream should be publicly accessible or private in Live to VOD (Video on Demand).

const (
	MediaPolicyPublic  MediaPolicy = "public"
	MediaPolicyPrivate MediaPolicy = "private"
)

func (MediaPolicy) ToPointer

func (e MediaPolicy) ToPointer() *MediaPolicy

func (*MediaPolicy) UnmarshalJSON

func (e *MediaPolicy) UnmarshalJSON(data []byte) error

type Moderation

type Moderation struct {
	// Defines the type of input. Possible values include video, audio, av.
	//
	Type CreateMediaRequestType `json:"type"`
}

func (*Moderation) GetType

func (o *Moderation) GetType() CreateMediaRequestType

type NotFoundErrorError

type NotFoundErrorError struct {
	// Displays the error code indicating the type of the error.
	Code *float64 `json:"code,omitempty"`
	// A descriptive message providing more details for the error.
	Message *string `json:"message,omitempty"`
	// A detailed explanation of the possible causes for the error.
	//
	Description *string `json:"description,omitempty"`
}

NotFoundErrorError - Displays details about the reasons behind the request's failure.

func (*NotFoundErrorError) GetCode

func (o *NotFoundErrorError) GetCode() *float64

func (*NotFoundErrorError) GetDescription

func (o *NotFoundErrorError) GetDescription() *string

func (*NotFoundErrorError) GetMessage

func (o *NotFoundErrorError) GetMessage() *string

type NotFoundErrorPlaybackIDError

type NotFoundErrorPlaybackIDError struct {
	// Displays the error code indicating the type of the error.
	Code *float64 `json:"code,omitempty"`
	// A descriptive message providing more details for the error.
	Message *string `json:"message,omitempty"`
	// A detailed explanation of the possible causes for the error.
	//
	Description *string `json:"description,omitempty"`
}

NotFoundErrorPlaybackIDError - Displays details about the reasons behind the request's failure.

func (*NotFoundErrorPlaybackIDError) GetCode

func (o *NotFoundErrorPlaybackIDError) GetCode() *float64

func (*NotFoundErrorPlaybackIDError) GetDescription

func (o *NotFoundErrorPlaybackIDError) GetDescription() *string

func (*NotFoundErrorPlaybackIDError) GetMessage

func (o *NotFoundErrorPlaybackIDError) GetMessage() *string

type NotFoundErrorSimulcastError

type NotFoundErrorSimulcastError struct {
	// Displays the error code indicating the type of the error.
	Code *float64 `json:"code,omitempty"`
	// A descriptive message providing more details for the error.
	Message *string `json:"message,omitempty"`
	// A detailed explanation of the possible causes for the error.
	//
	Description *string `json:"description,omitempty"`
}

NotFoundErrorSimulcastError - Displays details about the reasons behind the request's failure.

func (*NotFoundErrorSimulcastError) GetCode

func (o *NotFoundErrorSimulcastError) GetCode() *float64

func (*NotFoundErrorSimulcastError) GetDescription

func (o *NotFoundErrorSimulcastError) GetDescription() *string

func (*NotFoundErrorSimulcastError) GetMessage

func (o *NotFoundErrorSimulcastError) GetMessage() *string

type Pagination

type Pagination struct {
	// It gives the total number of media assets that are accessible overall.
	TotalRecords *int64 `json:"totalRecords,omitempty"`
	// Determines the current point for data retrieval within a paginated list.
	CurrentOffset *int64 `json:"currentOffset,omitempty"`
	// The offset count is expressed as total records by limit.
	OffsetCount *int64 `json:"offsetCount,omitempty"`
}

Pagination organizes content into pages for better readability and navigation.

func (*Pagination) GetCurrentOffset

func (o *Pagination) GetCurrentOffset() *int64

func (*Pagination) GetOffsetCount

func (o *Pagination) GetOffsetCount() *int64

func (*Pagination) GetTotalRecords

func (o *Pagination) GetTotalRecords() *int64

type PatchLiveStreamRequest

type PatchLiveStreamRequest struct {
	// You can search for videos with specific key value pairs using metadata, when you tag a video in "key":"value"s pairs. Dynamic Metadata allows you to define a key that allows any value pair. You can have maximum of 255 characters and upto 10 entries are allowed.
	Metadata *PatchLiveStreamRequestMetadata `json:"metadata,omitempty"`
	// In case the software streaming the live, get disrupted for any reason and get disconnect from FastPix, the reconnect window specifies the waiting time span of FastPix will wait before ending the stream. Before starting the stream, you can set the reconnect window time set which is up to 1800 seconds.
	ReconnectWindow *int64 `default:"60" json:"reconnectWindow"`
}

func (*PatchLiveStreamRequest) GetMetadata

func (*PatchLiveStreamRequest) GetReconnectWindow

func (o *PatchLiveStreamRequest) GetReconnectWindow() *int64

func (PatchLiveStreamRequest) MarshalJSON

func (p PatchLiveStreamRequest) MarshalJSON() ([]byte, error)

func (*PatchLiveStreamRequest) UnmarshalJSON

func (p *PatchLiveStreamRequest) UnmarshalJSON(data []byte) error

type PatchLiveStreamRequestMetadata

type PatchLiveStreamRequestMetadata struct {
}

PatchLiveStreamRequestMetadata - You can search for videos with specific key value pairs using metadata, when you tag a video in "key":"value"s pairs. Dynamic Metadata allows you to define a key that allows any value pair. You can have maximum of 255 characters and upto 10 entries are allowed.

type PatchResponseDTO

type PatchResponseDTO struct {
	// It demonstrates whether the request is successful or not.
	Success *bool `json:"success,omitempty"`
	// Displays the result of the request.
	Data *PatchResponseData `json:"data,omitempty"`
}

PatchResponseDTO - Displays the result of the request.

func (*PatchResponseDTO) GetData

func (o *PatchResponseDTO) GetData() *PatchResponseData

func (*PatchResponseDTO) GetSuccess

func (o *PatchResponseDTO) GetSuccess() *bool

type PatchResponseData

type PatchResponseData struct {
	// Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
	StreamID *string `json:"streamId,omitempty"`
	// A unique stream key is generated for streaming, allowing the user to start streaming on any third-party platform using this key.
	StreamKey *string `json:"streamKey,omitempty"`
	// A secret used for securing the SRT stream. This ensures that only authorized users can access the stream.
	SrtSecret *string `json:"srtSecret,omitempty"`
	// FastPix allows for a to trial the live stream for free. The duration of trial streams is five minutes. After five minutes of activity, the trial stream is turned off, and the recorded asset is removed after a day.
	Trial *bool `json:"trial,omitempty"`
	// The current live stream status can be one of four values:Idle, Preparing, Active or Disabled.The Idle status signifies that there isn't a broadcast in progress.The preparing status indicates that the stream is getting prepared. while, the Active status indicates that a broadcast is currently in progress. The Disabled status means that no more RTMP streams can be published.
	Status *string `json:"status,omitempty"`
	// Max resolution can be used to control the maximum resolution your media is encoded, stored, and streamed at.
	MaxResolution *string `json:"maxResolution,omitempty"`
	// The maximum duration in seconds that a live stream can have before it ends the stream.
	MaxDuration *int64 `json:"maxDuration,omitempty"`
	// It is the moment when the stream was created Time the media was generated, defined as a localDateTime (UTC Time).
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	// In case the software streaming the live, get disrupted for any reason and get disconnect from FastPix, the reconnect window specifies the waiting time span of FastPix will wait before ending the stream. Before starting the stream, you can set the reconnect window time set which is up to 1800 seconds.
	ReconnectWindow *int64 `json:"reconnectWindow,omitempty"`
	// When set to true, the livestream will be recorded and stored for later viewing purposes. If set to false, the livestream will not be recorded.
	EnableRecording *bool `json:"enableRecording,omitempty"`
	// Determines whether the recorded stream should be publicly accessible or private in Live to VOD (Video on Demand).
	MediaPolicy *string `json:"mediaPolicy,omitempty"`
	// You can search for videos with specific key value pairs using metadata, when you tag a video in "key":"value"s pairs. Dynamic Metadata allows you to define a key that allows any value pair. You can have maximum of 255 characters and upto 10 entries are allowed.
	Metadata   *PatchResponseDataMetadata `json:"metadata,omitempty"`
	PlaybackID []PlaybackIds              `json:"playbackId,omitempty"`
	// This object contains the livestream playback response details for SRT Protocol.
	SrtPlaybackResponse *PatchResponseDataSrtPlaybackResponse `json:"srtPlaybackResponse,omitempty"`
}

PatchResponseData - Displays the result of the request.

func (*PatchResponseData) GetCreatedAt

func (o *PatchResponseData) GetCreatedAt() *time.Time

func (*PatchResponseData) GetEnableRecording

func (o *PatchResponseData) GetEnableRecording() *bool

func (*PatchResponseData) GetMaxDuration

func (o *PatchResponseData) GetMaxDuration() *int64

func (*PatchResponseData) GetMaxResolution

func (o *PatchResponseData) GetMaxResolution() *string

func (*PatchResponseData) GetMediaPolicy

func (o *PatchResponseData) GetMediaPolicy() *string

func (*PatchResponseData) GetMetadata

func (o *PatchResponseData) GetMetadata() *PatchResponseDataMetadata

func (*PatchResponseData) GetPlaybackID

func (o *PatchResponseData) GetPlaybackID() []PlaybackIds

func (*PatchResponseData) GetReconnectWindow

func (o *PatchResponseData) GetReconnectWindow() *int64

func (*PatchResponseData) GetSrtPlaybackResponse

func (o *PatchResponseData) GetSrtPlaybackResponse() *PatchResponseDataSrtPlaybackResponse

func (*PatchResponseData) GetSrtSecret

func (o *PatchResponseData) GetSrtSecret() *string

func (*PatchResponseData) GetStatus

func (o *PatchResponseData) GetStatus() *string

func (*PatchResponseData) GetStreamID

func (o *PatchResponseData) GetStreamID() *string

func (*PatchResponseData) GetStreamKey

func (o *PatchResponseData) GetStreamKey() *string

func (*PatchResponseData) GetTrial

func (o *PatchResponseData) GetTrial() *bool

func (PatchResponseData) MarshalJSON

func (p PatchResponseData) MarshalJSON() ([]byte, error)

func (*PatchResponseData) UnmarshalJSON

func (p *PatchResponseData) UnmarshalJSON(data []byte) error

type PatchResponseDataMetadata

type PatchResponseDataMetadata struct {
}

PatchResponseDataMetadata - You can search for videos with specific key value pairs using metadata, when you tag a video in "key":"value"s pairs. Dynamic Metadata allows you to define a key that allows any value pair. You can have maximum of 255 characters and upto 10 entries are allowed.

type PatchResponseDataSrtPlaybackResponse

type PatchResponseDataSrtPlaybackResponse struct {
	// A unique identifier for the SRT playback stream. This ID is used to distinguish between different playback streams.
	SrtPlaybackStreamID *string `json:"srtPlaybackStreamId,omitempty"`
	// A playback secret used for securing the SRT playback stream. This ensures that only authorized users can access the playback.
	SrtPlaybackSecret *string `json:"srtPlaybackSecret,omitempty"`
}

PatchResponseDataSrtPlaybackResponse - This object contains the livestream playback response details for SRT Protocol.

func (*PatchResponseDataSrtPlaybackResponse) GetSrtPlaybackSecret

func (o *PatchResponseDataSrtPlaybackResponse) GetSrtPlaybackSecret() *string

func (*PatchResponseDataSrtPlaybackResponse) GetSrtPlaybackStreamID

func (o *PatchResponseDataSrtPlaybackResponse) GetSrtPlaybackStreamID() *string

type Placement

type Placement struct {
	// Horizontal alignment of the watermark.
	XAlign *XAlign `json:"xAlign,omitempty"`
	// Horizontal margin from the edge of the video.
	XMargin *string `json:"xMargin,omitempty"`
	// Vertical alignment of the watermark.
	YAlign *YAlign `json:"yAlign,omitempty"`
	// Vertical margin from the edge of the video.
	YMargin *string `json:"yMargin,omitempty"`
}

func (*Placement) GetXAlign

func (o *Placement) GetXAlign() *XAlign

func (*Placement) GetXMargin

func (o *Placement) GetXMargin() *string

func (*Placement) GetYAlign

func (o *Placement) GetYAlign() *YAlign

func (*Placement) GetYMargin

func (o *Placement) GetYMargin() *string

type PlaybackID

type PlaybackID struct {
	// A unique identifier is generated by FastPix for the playbacks.
	ID *string `json:"id,omitempty"`
	// Determines if access to the streamed content is kept private or available to all.
	AccessPolicy *PlaybackIDAccessPolicy `json:"accessPolicy,omitempty"`
	// Controls access based on domains and user agents. Defines a default policy (either "allow" or "deny") and provides lists for explicitly allowed or denied domains and user agents.
	AccessRestrictions *PlaybackIDAccessRestrictions `json:"accessRestrictions,omitempty"`
}

PlaybackID - A collection of Playback ID objects utilized for crafting HLS playback urls.

func (*PlaybackID) GetAccessPolicy

func (o *PlaybackID) GetAccessPolicy() *PlaybackIDAccessPolicy

func (*PlaybackID) GetAccessRestrictions

func (o *PlaybackID) GetAccessRestrictions() *PlaybackIDAccessRestrictions

func (*PlaybackID) GetID

func (o *PlaybackID) GetID() *string

type PlaybackIDAccessPolicy

type PlaybackIDAccessPolicy string

PlaybackIDAccessPolicy - Determines if access to the streamed content is kept private or available to all.

const (
	PlaybackIDAccessPolicyPublic  PlaybackIDAccessPolicy = "public"
	PlaybackIDAccessPolicyPrivate PlaybackIDAccessPolicy = "private"
	PlaybackIDAccessPolicyDrm     PlaybackIDAccessPolicy = "drm"
)

func (PlaybackIDAccessPolicy) ToPointer

func (*PlaybackIDAccessPolicy) UnmarshalJSON

func (e *PlaybackIDAccessPolicy) UnmarshalJSON(data []byte) error

type PlaybackIDAccessRestrictions

type PlaybackIDAccessRestrictions struct {
	// Restrictions based on the originating domain of a request (e.g., whether requests from certain websites should be allowed or blocked).
	Domains *PlaybackIDDomains `json:"domains,omitempty"`
	// Restrictions based on the user agent (which is typically a string sent by browsers or bots identifying themselves).
	UserAgents *PlaybackIDUserAgents `json:"userAgents,omitempty"`
}

PlaybackIDAccessRestrictions - Controls access based on domains and user agents. Defines a default policy (either "allow" or "deny") and provides lists for explicitly allowed or denied domains and user agents.

func (*PlaybackIDAccessRestrictions) GetDomains

func (*PlaybackIDAccessRestrictions) GetUserAgents

type PlaybackIDDomains

type PlaybackIDDomains struct {
	// This sets the default behavior for domain access (either "allow" or "deny").
	DefaultPolicy *PlaybackIDDomainsDefaultPolicy `json:"defaultPolicy,omitempty"`
	// A list of domains that are explicitly allowed access.
	Allow []string `json:"allow,omitempty"`
	// A list of domains that are explicitly blocked from accessing the resource.
	Deny []string `json:"deny,omitempty"`
}

PlaybackIDDomains - Restrictions based on the originating domain of a request (e.g., whether requests from certain websites should be allowed or blocked).

func (*PlaybackIDDomains) GetAllow

func (o *PlaybackIDDomains) GetAllow() []string

func (*PlaybackIDDomains) GetDefaultPolicy

func (o *PlaybackIDDomains) GetDefaultPolicy() *PlaybackIDDomainsDefaultPolicy

func (*PlaybackIDDomains) GetDeny

func (o *PlaybackIDDomains) GetDeny() []string

type PlaybackIDDomainsDefaultPolicy

type PlaybackIDDomainsDefaultPolicy string

PlaybackIDDomainsDefaultPolicy - This sets the default behavior for domain access (either "allow" or "deny").

const (
	PlaybackIDDomainsDefaultPolicyAllow PlaybackIDDomainsDefaultPolicy = "allow"
	PlaybackIDDomainsDefaultPolicyDeny  PlaybackIDDomainsDefaultPolicy = "deny"
)

func (PlaybackIDDomainsDefaultPolicy) ToPointer

func (*PlaybackIDDomainsDefaultPolicy) UnmarshalJSON

func (e *PlaybackIDDomainsDefaultPolicy) UnmarshalJSON(data []byte) error

type PlaybackIDRequest

type PlaybackIDRequest struct {
	// Determines if access to the streamed content is kept private or available to all.
	AccessPolicy *PlaybackIDRequestAccessPolicy `default:"public" json:"accessPolicy"`
}

func (*PlaybackIDRequest) GetAccessPolicy

func (o *PlaybackIDRequest) GetAccessPolicy() *PlaybackIDRequestAccessPolicy

func (PlaybackIDRequest) MarshalJSON

func (p PlaybackIDRequest) MarshalJSON() ([]byte, error)

func (*PlaybackIDRequest) UnmarshalJSON

func (p *PlaybackIDRequest) UnmarshalJSON(data []byte) error

type PlaybackIDRequestAccessPolicy

type PlaybackIDRequestAccessPolicy string

PlaybackIDRequestAccessPolicy - Determines if access to the streamed content is kept private or available to all.

const (
	PlaybackIDRequestAccessPolicyPublic  PlaybackIDRequestAccessPolicy = "public"
	PlaybackIDRequestAccessPolicyPrivate PlaybackIDRequestAccessPolicy = "private"
)

func (PlaybackIDRequestAccessPolicy) ToPointer

func (*PlaybackIDRequestAccessPolicy) UnmarshalJSON

func (e *PlaybackIDRequestAccessPolicy) UnmarshalJSON(data []byte) error

type PlaybackIDResponse

type PlaybackIDResponse struct {
	// It demonstrates whether the request is successful or not.
	Success *bool                   `json:"success,omitempty"`
	Data    *PlaybackIDResponseData `json:"data,omitempty"`
}

PlaybackIDResponse - Displays the result of the request.

func (*PlaybackIDResponse) GetData

func (*PlaybackIDResponse) GetSuccess

func (o *PlaybackIDResponse) GetSuccess() *bool

type PlaybackIDResponseData

type PlaybackIDResponseData struct {
	// Unique identifier for the playbackId
	ID *string `json:"id,omitempty"`
	// Determines if access to the streamed content is kept private or available to all.
	AccessPolicy *string `json:"accessPolicy,omitempty"`
}

func (*PlaybackIDResponseData) GetAccessPolicy

func (o *PlaybackIDResponseData) GetAccessPolicy() *string

func (*PlaybackIDResponseData) GetID

func (o *PlaybackIDResponseData) GetID() *string

type PlaybackIDUserAgents

type PlaybackIDUserAgents struct {
	// This sets the default behavior for user agent access (either "allow" or "deny").
	DefaultPolicy *PlaybackIDUserAgentsDefaultPolicy `json:"defaultPolicy,omitempty"`
	// A list of specific user agents that are allowed to access the resource.
	Allow []string `json:"allow,omitempty"`
	// A list of specific user agents that are blocked.
	Deny []string `json:"deny,omitempty"`
}

PlaybackIDUserAgents - Restrictions based on the user agent (which is typically a string sent by browsers or bots identifying themselves).

func (*PlaybackIDUserAgents) GetAllow

func (o *PlaybackIDUserAgents) GetAllow() []string

func (*PlaybackIDUserAgents) GetDefaultPolicy

func (*PlaybackIDUserAgents) GetDeny

func (o *PlaybackIDUserAgents) GetDeny() []string

type PlaybackIDUserAgentsDefaultPolicy

type PlaybackIDUserAgentsDefaultPolicy string

PlaybackIDUserAgentsDefaultPolicy - This sets the default behavior for user agent access (either "allow" or "deny").

const (
	PlaybackIDUserAgentsDefaultPolicyAllow PlaybackIDUserAgentsDefaultPolicy = "allow"
	PlaybackIDUserAgentsDefaultPolicyDeny  PlaybackIDUserAgentsDefaultPolicy = "deny"
)

func (PlaybackIDUserAgentsDefaultPolicy) ToPointer

func (*PlaybackIDUserAgentsDefaultPolicy) UnmarshalJSON

func (e *PlaybackIDUserAgentsDefaultPolicy) UnmarshalJSON(data []byte) error

type PlaybackIds

type PlaybackIds struct {
	// Unique identifier for the playbackId
	ID *string `json:"id,omitempty"`
	// Determines if access to the streamed content is kept private or available to all.
	AccessPolicy *string `json:"accessPolicy,omitempty"`
}

PlaybackIds - A collection of Playback ID objects utilized for crafting HLS playback urls.

func (*PlaybackIds) GetAccessPolicy

func (o *PlaybackIds) GetAccessPolicy() *string

func (*PlaybackIds) GetID

func (o *PlaybackIds) GetID() *string

type PlaybackSettings

type PlaybackSettings struct {
	// Determines if access to the streamed content is kept private or available to all.
	AccessPolicy *PlaybackSettingsAccessPolicy `default:"public" json:"accessPolicy"`
}

PlaybackSettings - Displays the result of the playback settings.

func (*PlaybackSettings) GetAccessPolicy

func (o *PlaybackSettings) GetAccessPolicy() *PlaybackSettingsAccessPolicy

func (PlaybackSettings) MarshalJSON

func (p PlaybackSettings) MarshalJSON() ([]byte, error)

func (*PlaybackSettings) UnmarshalJSON

func (p *PlaybackSettings) UnmarshalJSON(data []byte) error

type PlaybackSettingsAccessPolicy

type PlaybackSettingsAccessPolicy string

PlaybackSettingsAccessPolicy - Determines if access to the streamed content is kept private or available to all.

const (
	PlaybackSettingsAccessPolicyPublic  PlaybackSettingsAccessPolicy = "public"
	PlaybackSettingsAccessPolicyPrivate PlaybackSettingsAccessPolicy = "private"
)

func (PlaybackSettingsAccessPolicy) ToPointer

func (*PlaybackSettingsAccessPolicy) UnmarshalJSON

func (e *PlaybackSettingsAccessPolicy) UnmarshalJSON(data []byte) error

type Security

type Security struct {
	Username *string `security:"scheme,type=http,subtype=basic,name=username,env=fastpixsdk_username"`
	Password *string `security:"scheme,type=http,subtype=basic,name=password,env=fastpixsdk_password"`
}

func (*Security) GetPassword

func (o *Security) GetPassword() *string

func (*Security) GetUsername

func (o *Security) GetUsername() *string

type Segment1

type Segment1 struct {
	// URL of the segment to be added.
	URL string `json:"url"`
	// The timestamp at which the segment should be inserted.
	InsertAt int64 `json:"insertAt"`
}

func (*Segment1) GetInsertAt

func (o *Segment1) GetInsertAt() int64

func (*Segment1) GetURL

func (o *Segment1) GetURL() string

type Segment2

type Segment2 struct {
	// URL of the segment to be added.
	URL string `json:"url"`
	// Flag indicating the segment should be inserted at the end.
	InsertAtEnd bool `json:"insertAtEnd"`
}

func (*Segment2) GetInsertAtEnd

func (o *Segment2) GetInsertAtEnd() bool

func (*Segment2) GetURL

func (o *Segment2) GetURL() string

type SegmentUnion

type SegmentUnion struct {
	Segment1 *Segment1 `queryParam:"inline"`
	Segment2 *Segment2 `queryParam:"inline"`

	Type SegmentUnionType
}

func CreateSegmentUnionSegment1

func CreateSegmentUnionSegment1(segment1 Segment1) SegmentUnion

func CreateSegmentUnionSegment2

func CreateSegmentUnionSegment2(segment2 Segment2) SegmentUnion

func (SegmentUnion) MarshalJSON

func (u SegmentUnion) MarshalJSON() ([]byte, error)

func (*SegmentUnion) UnmarshalJSON

func (u *SegmentUnion) UnmarshalJSON(data []byte) error

type SegmentUnionType

type SegmentUnionType string
const (
	SegmentUnionTypeSegment1 SegmentUnionType = "segment_1"
	SegmentUnionTypeSegment2 SegmentUnionType = "segment_2"
)

type SimulcastRequest

type SimulcastRequest struct {
	// The RTMP hostname, combined with the application name, is crucial for connecting to third-party live streaming services and transmitting the live stream.
	URL *string `json:"url,omitempty"`
	// A unique stream key is generated for streaming, allowing the user to start streaming on any third-party platform using this key.
	StreamKey *string `json:"streamKey,omitempty"`
}

func (*SimulcastRequest) GetStreamKey

func (o *SimulcastRequest) GetStreamKey() *string

func (*SimulcastRequest) GetURL

func (o *SimulcastRequest) GetURL() *string

type SimulcastResponse

type SimulcastResponse struct {
	// It demonstrates whether the request is successful or not.
	Success *bool `json:"success,omitempty"`
	// Displays the result of the request.
	Data *SimulcastResponseData `json:"data,omitempty"`
}

SimulcastResponse - Displays the result of the request.

func (*SimulcastResponse) GetData

func (*SimulcastResponse) GetSuccess

func (o *SimulcastResponse) GetSuccess() *bool

type SimulcastResponseData

type SimulcastResponseData struct {
	// When you create the new simulcast, FastPix assign a universal unique identifier which can contain a maximum of 255 characters.
	SimulcastID *string `json:"simulcastId,omitempty"`
	// The RTMP hostname, combined with the application name, is crucial for connecting to third-party live streaming services and transmitting the live stream.
	URL *string `json:"url,omitempty"`
	// A unique stream key is generated for streaming, allowing the user to start streaming on any third-party platform using this key.
	StreamKey *string `json:"streamKey,omitempty"`
	// When the value is true, the simulcast will be enabled for the given stream
	IsEnabled *bool `json:"isEnabled,omitempty"`
	// Arbitrary user-supplied metadata that will be included in the simulcast details. Can be used to store your own ID for a video along with the simulcast. Max:255 characters, Upto 10 entries are allowed.
	Metadata *SimulcastResponseMetadata `json:"metadata,omitempty"`
}

SimulcastResponseData - Displays the result of the request.

func (*SimulcastResponseData) GetIsEnabled

func (o *SimulcastResponseData) GetIsEnabled() *bool

func (*SimulcastResponseData) GetMetadata

func (*SimulcastResponseData) GetSimulcastID

func (o *SimulcastResponseData) GetSimulcastID() *string

func (*SimulcastResponseData) GetStreamKey

func (o *SimulcastResponseData) GetStreamKey() *string

func (*SimulcastResponseData) GetURL

func (o *SimulcastResponseData) GetURL() *string

type SimulcastResponseMetadata

type SimulcastResponseMetadata struct {
}

SimulcastResponseMetadata - Arbitrary user-supplied metadata that will be included in the simulcast details. Can be used to store your own ID for a video along with the simulcast. Max:255 characters, Upto 10 entries are allowed.

type SimulcastUnavailableError

type SimulcastUnavailableError struct {
	// An error code indicating the type of the error.
	//
	Code *int64 `json:"code,omitempty"`
	// A descriptive message providing more details for the error
	//
	Message *string `json:"message,omitempty"`
	// A detailed explanation of the possible causes for the error.
	//
	Description *string `json:"description,omitempty"`
}

SimulcastUnavailableError - Returns the problem that has occured.

func (*SimulcastUnavailableError) GetCode

func (o *SimulcastUnavailableError) GetCode() *int64

func (*SimulcastUnavailableError) GetDescription

func (o *SimulcastUnavailableError) GetDescription() *string

func (*SimulcastUnavailableError) GetMessage

func (o *SimulcastUnavailableError) GetMessage() *string

type SimulcastUpdateRequest

type SimulcastUpdateRequest struct {
	// When the value is set to false, the simulcast will be disabled for the given stream.
	IsEnabled *bool `json:"isEnabled,omitempty"`
	// Arbitrary user-supplied metadata that will be included in the simulcast details. Can be used to store your own ID for a video along with the simulcast. Max:255 characters, Upto 10 entries are allowed.
	Metadata *SimulcastUpdateRequestMetadata `json:"metadata,omitempty"`
}

func (*SimulcastUpdateRequest) GetIsEnabled

func (o *SimulcastUpdateRequest) GetIsEnabled() *bool

func (*SimulcastUpdateRequest) GetMetadata

type SimulcastUpdateRequestMetadata

type SimulcastUpdateRequestMetadata struct {
}

SimulcastUpdateRequestMetadata - Arbitrary user-supplied metadata that will be included in the simulcast details. Can be used to store your own ID for a video along with the simulcast. Max:255 characters, Upto 10 entries are allowed.

type SimulcastUpdateResponse

type SimulcastUpdateResponse struct {
	// It demonstrates whether the request is successful or not.
	Success *bool `json:"success,omitempty"`
	// Displays the result of the request.
	Data *SimulcastUpdateResponseData `json:"data,omitempty"`
}

SimulcastUpdateResponse - Displays the result of the request.

func (*SimulcastUpdateResponse) GetData

func (*SimulcastUpdateResponse) GetSuccess

func (o *SimulcastUpdateResponse) GetSuccess() *bool

type SimulcastUpdateResponseData

type SimulcastUpdateResponseData struct {
	// When you create the new simulcast, FastPix assign a universal unique identifier which can contain a maximum of 255 characters.
	SimulcastID *string `json:"simulcastId,omitempty"`
	// The RTMP hostname, combined with the application name, is crucial for connecting to third-party live streaming services and transmitting the live stream.
	URL *string `json:"url,omitempty"`
	// A unique stream key is generated for streaming, allowing the user to start streaming on any third-party platform using this key.
	StreamKey *string `json:"streamKey,omitempty"`
	// When the value is set to false, the simulcast will be disabled for the given stream
	IsEnabled *bool `json:"isEnabled,omitempty"`
	// Arbitrary user-supplied metadata that will be included in the simulcast details. Can be used to store your own ID for a video along with the simulcast. Max:255 characters, Upto 10 entries are allowed.
	Metadata *SimulcastUpdateResponseMetadata `json:"metadata,omitempty"`
}

SimulcastUpdateResponseData - Displays the result of the request.

func (*SimulcastUpdateResponseData) GetIsEnabled

func (o *SimulcastUpdateResponseData) GetIsEnabled() *bool

func (*SimulcastUpdateResponseData) GetMetadata

func (*SimulcastUpdateResponseData) GetSimulcastID

func (o *SimulcastUpdateResponseData) GetSimulcastID() *string

func (*SimulcastUpdateResponseData) GetStreamKey

func (o *SimulcastUpdateResponseData) GetStreamKey() *string

func (*SimulcastUpdateResponseData) GetURL

func (o *SimulcastUpdateResponseData) GetURL() *string

type SimulcastUpdateResponseMetadata

type SimulcastUpdateResponseMetadata struct {
}

SimulcastUpdateResponseMetadata - Arbitrary user-supplied metadata that will be included in the simulcast details. Can be used to store your own ID for a video along with the simulcast. Max:255 characters, Upto 10 entries are allowed.

type SimulcastdeleteResponse

type SimulcastdeleteResponse struct {
	// It demonstrates whether the request is successful or not.
	Success *bool `json:"success,omitempty"`
}

func (*SimulcastdeleteResponse) GetSuccess

func (o *SimulcastdeleteResponse) GetSuccess() *bool

type SourceResolution

type SourceResolution string

SourceResolution - The actual resolution of the uploaded media. This represents the native quality of the source media.

const (
	SourceResolutionTwoThousandOneHundredAndSixtyp  SourceResolution = "2160p"
	SourceResolutionOneThousandFourHundredAndFortyp SourceResolution = "1440p"
	SourceResolutionOneThousandAndEightyp           SourceResolution = "1080p"
	SourceResolutionSevenHundredAndTwentyp          SourceResolution = "720p"
	SourceResolutionFourHundredAndEightyp           SourceResolution = "480p"
	SourceResolutionThreeHundredAndSixtyp           SourceResolution = "360p"
)

func (SourceResolution) ToPointer

func (e SourceResolution) ToPointer() *SourceResolution

func (*SourceResolution) UnmarshalJSON

func (e *SourceResolution) UnmarshalJSON(data []byte) error

type Subtitle

type Subtitle struct {
	// Name of the language in which the subtitles will be generated.
	//
	LanguageName *string `json:"languageName,omitempty"`
	// You can search for videos with specific key-value pairs using metadata, when you tag a video in "key" : "value" pairs. Dynamic Metadata allows you to define a key that allows any value pair. You can have a maximum of 255 characters and up to 10 entries are allowed.
	//
	Metadata *SubtitleMetadata `json:"metadata,omitempty"`
	// Language codes are concise, standardized symbols that denote languages, utilizing either two or three characters for identification. The language code must be compliant with the BCP 47 standard to ensure compatibility. (for text only).
	//
	LanguageCode *CreateMediaRequestLanguageCode `json:"languageCode,omitempty"`
}

Subtitle - Generates subtitle files for audio/video files.

func (*Subtitle) GetLanguageCode

func (o *Subtitle) GetLanguageCode() *CreateMediaRequestLanguageCode

func (*Subtitle) GetLanguageName

func (o *Subtitle) GetLanguageName() *string

func (*Subtitle) GetMetadata

func (o *Subtitle) GetMetadata() *SubtitleMetadata

type SubtitleInput

type SubtitleInput struct {
	// Defines the type of input.
	//
	Type string `json:"type"`
	// The direct URL of the subtitle file.
	URL string `json:"url"`
	// Name of the language in which the subtitles will be generated.
	LanguageName string `json:"languageName"`
	// The BCP 47 language code representing the language of the generated track.
	//
	LanguageCode SubtitleInputLanguageCode `json:"languageCode"`
}

SubtitleInput - Generates subtitle files for audio/video files.

func (*SubtitleInput) GetLanguageCode

func (o *SubtitleInput) GetLanguageCode() SubtitleInputLanguageCode

func (*SubtitleInput) GetLanguageName

func (o *SubtitleInput) GetLanguageName() string

func (*SubtitleInput) GetType

func (o *SubtitleInput) GetType() string

func (*SubtitleInput) GetURL

func (o *SubtitleInput) GetURL() string

type SubtitleInputLanguageCode

type SubtitleInputLanguageCode string

SubtitleInputLanguageCode - The BCP 47 language code representing the language of the generated track.

const (
	SubtitleInputLanguageCodeArSa SubtitleInputLanguageCode = "ar-SA"
	SubtitleInputLanguageCodeBnBd SubtitleInputLanguageCode = "bn-BD"
	SubtitleInputLanguageCodeBnIn SubtitleInputLanguageCode = "bn-IN"
	SubtitleInputLanguageCodeCaEs SubtitleInputLanguageCode = "ca-ES"
	SubtitleInputLanguageCodeCsCz SubtitleInputLanguageCode = "cs-CZ"
	SubtitleInputLanguageCodeDaDk SubtitleInputLanguageCode = "da-DK"
	SubtitleInputLanguageCodeDeAt SubtitleInputLanguageCode = "de-AT"
	SubtitleInputLanguageCodeDeCh SubtitleInputLanguageCode = "de-CH"
	SubtitleInputLanguageCodeDeDe SubtitleInputLanguageCode = "de-DE"
	SubtitleInputLanguageCodeElGr SubtitleInputLanguageCode = "el-GR"
	SubtitleInputLanguageCodeEnAu SubtitleInputLanguageCode = "en-AU"
	SubtitleInputLanguageCodeEnCa SubtitleInputLanguageCode = "en-CA"
	SubtitleInputLanguageCodeEnGb SubtitleInputLanguageCode = "en-GB"
	SubtitleInputLanguageCodeEnIe SubtitleInputLanguageCode = "en-IE"
	SubtitleInputLanguageCodeEnIn SubtitleInputLanguageCode = "en-IN"
	SubtitleInputLanguageCodeEnNz SubtitleInputLanguageCode = "en-NZ"
	SubtitleInputLanguageCodeEnUs SubtitleInputLanguageCode = "en-US"
	SubtitleInputLanguageCodeEnZa SubtitleInputLanguageCode = "en-ZA"
	SubtitleInputLanguageCodeEsAr SubtitleInputLanguageCode = "es-AR"
	SubtitleInputLanguageCodeEsCl SubtitleInputLanguageCode = "es-CL"
	SubtitleInputLanguageCodeEsCo SubtitleInputLanguageCode = "es-CO"
	SubtitleInputLanguageCodeEsEs SubtitleInputLanguageCode = "es-ES"
	SubtitleInputLanguageCodeEsMx SubtitleInputLanguageCode = "es-MX"
	SubtitleInputLanguageCodeEsUs SubtitleInputLanguageCode = "es-US"
	SubtitleInputLanguageCodeFiFi SubtitleInputLanguageCode = "fi-FI"
	SubtitleInputLanguageCodeFrBe SubtitleInputLanguageCode = "fr-BE"
	SubtitleInputLanguageCodeFrCa SubtitleInputLanguageCode = "fr-CA"
	SubtitleInputLanguageCodeFrCh SubtitleInputLanguageCode = "fr-CH"
	SubtitleInputLanguageCodeFrFr SubtitleInputLanguageCode = "fr-FR"
	SubtitleInputLanguageCodeHeIl SubtitleInputLanguageCode = "he-IL"
	SubtitleInputLanguageCodeHiIn SubtitleInputLanguageCode = "hi-IN"
	SubtitleInputLanguageCodeHrHr SubtitleInputLanguageCode = "hr-HR"
	SubtitleInputLanguageCodeHuHu SubtitleInputLanguageCode = "hu-HU"
	SubtitleInputLanguageCodeIDID SubtitleInputLanguageCode = "id-ID"
	SubtitleInputLanguageCodeItCh SubtitleInputLanguageCode = "it-CH"
	SubtitleInputLanguageCodeItIt SubtitleInputLanguageCode = "it-IT"
	SubtitleInputLanguageCodeJaJp SubtitleInputLanguageCode = "ja-JP"
	SubtitleInputLanguageCodeKoKr SubtitleInputLanguageCode = "ko-KR"
	SubtitleInputLanguageCodeNlBe SubtitleInputLanguageCode = "nl-BE"
	SubtitleInputLanguageCodeNlNl SubtitleInputLanguageCode = "nl-NL"
	SubtitleInputLanguageCodeNoNo SubtitleInputLanguageCode = "no-NO"
	SubtitleInputLanguageCodePlPl SubtitleInputLanguageCode = "pl-PL"
	SubtitleInputLanguageCodePtBr SubtitleInputLanguageCode = "pt-BR"
	SubtitleInputLanguageCodePtPt SubtitleInputLanguageCode = "pt-PT"
	SubtitleInputLanguageCodeRoRo SubtitleInputLanguageCode = "ro-RO"
	SubtitleInputLanguageCodeRuRu SubtitleInputLanguageCode = "ru-RU"
	SubtitleInputLanguageCodeSkSk SubtitleInputLanguageCode = "sk-SK"
	SubtitleInputLanguageCodeSvSe SubtitleInputLanguageCode = "sv-SE"
	SubtitleInputLanguageCodeTaIn SubtitleInputLanguageCode = "ta-IN"
	SubtitleInputLanguageCodeTaLk SubtitleInputLanguageCode = "ta-LK"
	SubtitleInputLanguageCodeThTh SubtitleInputLanguageCode = "th-TH"
	SubtitleInputLanguageCodeTrTr SubtitleInputLanguageCode = "tr-TR"
	SubtitleInputLanguageCodeUkUa SubtitleInputLanguageCode = "uk-UA"
	SubtitleInputLanguageCodeBgBg SubtitleInputLanguageCode = "bg-BG"
	SubtitleInputLanguageCodeZhCn SubtitleInputLanguageCode = "zh-CN"
	SubtitleInputLanguageCodeZhHk SubtitleInputLanguageCode = "zh-HK"
	SubtitleInputLanguageCodeZhTw SubtitleInputLanguageCode = "zh-TW"
)

func (SubtitleInputLanguageCode) ToPointer

func (*SubtitleInputLanguageCode) UnmarshalJSON

func (e *SubtitleInputLanguageCode) UnmarshalJSON(data []byte) error

type SubtitleMetadata

type SubtitleMetadata struct {
}

SubtitleMetadata - You can search for videos with specific key-value pairs using metadata, when you tag a video in "key" : "value" pairs. Dynamic Metadata allows you to define a key that allows any value pair. You can have a maximum of 255 characters and up to 10 entries are allowed.

type Summary

type Summary struct {
	// Enable or disable the summary feature for the media. Set to true to enable summary or false to disable.
	//
	Generate bool `json:"generate"`
	// Specifies the desired word count for the generated summary.
	// - The value must be between **30** and **250** words.
	//
	SummaryLength *int64 `default:"100" json:"summaryLength"`
}

func (*Summary) GetGenerate

func (o *Summary) GetGenerate() bool

func (*Summary) GetSummaryLength

func (o *Summary) GetSummaryLength() *int64

func (Summary) MarshalJSON

func (s Summary) MarshalJSON() ([]byte, error)

func (*Summary) UnmarshalJSON

func (s *Summary) UnmarshalJSON(data []byte) error

type Track

type Track struct {
	// FastPix generates a unique identifier for each track.
	ID *string `json:"id,omitempty"`
	// Defines the type of input. This option is mandatory.
	Type string `json:"type"`
	// Track width denotes the range of widths applicable to a specific track. Currently, this setting can be modified only for video tracks
	Width *float64 `json:"width,omitempty"`
	// Track height denotes the range of height applicable to a specific track. Currently, this setting can be modified only for video tracks.
	Height *float64 `json:"height,omitempty"`
	// Frame rate quantifies the speed at which frames are displayed per second. It represents the range of frames available for a specific track. If the frame rate of the input file is indeterminable, it will be indicated by a value of -1.
	FrameRate *string `json:"frameRate,omitempty"`
	// Indicates if the track contains closed captions.
	ClosedCaptions *bool `json:"closedCaptions,omitempty"`
}

Track - A media consists of different media tracks, like video, audio, and subtitle, all combined.

func (*Track) GetClosedCaptions

func (o *Track) GetClosedCaptions() *bool

func (*Track) GetFrameRate

func (o *Track) GetFrameRate() *string

func (*Track) GetHeight

func (o *Track) GetHeight() *float64

func (*Track) GetID

func (o *Track) GetID() *string

func (*Track) GetType

func (o *Track) GetType() string

func (*Track) GetWidth

func (o *Track) GetWidth() *float64

type UnauthorizedError

type UnauthorizedError struct {
	// Displays the error code indicating the type of the error.
	Code *int64 `json:"code,omitempty"`
	// A descriptive message providing more details for the error.
	Message *string `json:"message,omitempty"`
	// A detailed explanation of the possible causes for the error.
	//
	Description *string `json:"description,omitempty"`
}

UnauthorizedError - Displays details about the reasons behind the request's failure.

func (*UnauthorizedError) GetCode

func (o *UnauthorizedError) GetCode() *int64

func (*UnauthorizedError) GetDescription

func (o *UnauthorizedError) GetDescription() *string

func (*UnauthorizedError) GetMessage

func (o *UnauthorizedError) GetMessage() *string

type ValidationErrorResponseError

type ValidationErrorResponseError struct {
	// An error code indicating the type of the error.
	Code *int64 `json:"code,omitempty"`
	// A descriptive message providing more details for the error
	Message *string `json:"message,omitempty"`
	// It is an array of objects, where each object contains information about a specific field and a corresponding error message.
	Fields []Field `json:"fields,omitempty"`
}

ValidationErrorResponseError - Returns the problem that has occured

func (*ValidationErrorResponseError) GetCode

func (o *ValidationErrorResponseError) GetCode() *int64

func (*ValidationErrorResponseError) GetFields

func (o *ValidationErrorResponseError) GetFields() []Field

func (*ValidationErrorResponseError) GetMessage

func (o *ValidationErrorResponseError) GetMessage() *string

type VideoInput

type VideoInput struct {
	// Defines the type of input.
	//
	Type string `json:"type"`
	// The url hosts the media file for FastPix, which needs to be downloaded to use further. It supports formats like MP3, MP4, MOV, MKV, or TS, and includes text tracks for subtitles/CC (SRT file/VTT file). While FastPix can handle various audio and video formats and codecs, using standard inputs can help with optimal processing speed.
	//
	URL string `json:"url"`
	// Start time indicates where encoding should begin within the video file. For example, if you want to encode a segment from 3 minutes (180 seconds) to 6 minutes (360 seconds) in a 10-minute (600 seconds) video, the start time is 3 minutes (180 seconds). Note: Start time is always mentioned in seconds.
	//
	StartTime *float64 `json:"startTime,omitempty"`
	// End time indicates where encoding should end within the video file. For example, if you want to encode a segment from 3 minutes (180 seconds) to 6 minutes (360 seconds) in a 10-minute (600 seconds) video, the end time is 6 minutes (360 seconds). Note: End time is always mentioned in seconds.
	//
	EndTime *float64 `json:"endTime,omitempty"`
	// The url of the intro video which is to be added at the start of the video.
	//
	IntroURL *string `json:"introUrl,omitempty"`
	// The url of the outro video which is to be added at the end of the video.
	//
	OutroURL *string `json:"outroUrl,omitempty"`
	// The list of the startTime-endTime of the segments to be removed from the actual video.
	//
	ExpungeSegments []string `json:"expungeSegments,omitempty"`
	// A list of media segments to be added or processed. Each segment includes details such as the URL of the media file and instructions on where it should be inserted in the final media composition. A segment can either specify an exact timestamp  (`insertAt`) or indicate that it should be added at the end (`insertAtEnd`).
	Segments []SegmentUnion `json:"segments,omitempty"`
}

func (*VideoInput) GetEndTime

func (o *VideoInput) GetEndTime() *float64

func (*VideoInput) GetExpungeSegments

func (o *VideoInput) GetExpungeSegments() []string

func (*VideoInput) GetIntroURL

func (o *VideoInput) GetIntroURL() *string

func (*VideoInput) GetOutroURL

func (o *VideoInput) GetOutroURL() *string

func (*VideoInput) GetSegments

func (o *VideoInput) GetSegments() []SegmentUnion

func (*VideoInput) GetStartTime

func (o *VideoInput) GetStartTime() *float64

func (*VideoInput) GetType

func (o *VideoInput) GetType() string

func (*VideoInput) GetURL

func (o *VideoInput) GetURL() string

type WatermarkInput

type WatermarkInput struct {
	// Type of overlay (currently only supports 'watermark').
	Type *WatermarkInputType `json:"type,omitempty"`
	// URL of the watermark image.
	URL       *string    `json:"url,omitempty"`
	Placement *Placement `json:"placement,omitempty"`
	// Width of the watermark in percentage or pixels.
	Width *string `json:"width,omitempty"`
	// Height of the watermark in percentage or pixels.
	Height *string `json:"height,omitempty"`
	// Opacity of the watermark in percentage.
	Opacity *string `json:"opacity,omitempty"`
}

func (*WatermarkInput) GetHeight

func (o *WatermarkInput) GetHeight() *string

func (*WatermarkInput) GetOpacity

func (o *WatermarkInput) GetOpacity() *string

func (*WatermarkInput) GetPlacement

func (o *WatermarkInput) GetPlacement() *Placement

func (*WatermarkInput) GetType

func (o *WatermarkInput) GetType() *WatermarkInputType

func (*WatermarkInput) GetURL

func (o *WatermarkInput) GetURL() *string

func (*WatermarkInput) GetWidth

func (o *WatermarkInput) GetWidth() *string

type WatermarkInputType

type WatermarkInputType string

WatermarkInputType - Type of overlay (currently only supports 'watermark').

const (
	WatermarkInputTypeWatermark WatermarkInputType = "watermark"
)

func (WatermarkInputType) ToPointer

func (e WatermarkInputType) ToPointer() *WatermarkInputType

func (*WatermarkInputType) UnmarshalJSON

func (e *WatermarkInputType) UnmarshalJSON(data []byte) error

type XAlign

type XAlign string

XAlign - Horizontal alignment of the watermark.

const (
	XAlignLeft   XAlign = "left"
	XAlignCenter XAlign = "center"
	XAlignRight  XAlign = "right"
)

func (XAlign) ToPointer

func (e XAlign) ToPointer() *XAlign

func (*XAlign) UnmarshalJSON

func (e *XAlign) UnmarshalJSON(data []byte) error

type YAlign

type YAlign string

YAlign - Vertical alignment of the watermark.

const (
	YAlignTop    YAlign = "top"
	YAlignMiddle YAlign = "middle"
	YAlignBottom YAlign = "bottom"
)

func (YAlign) ToPointer

func (e YAlign) ToPointer() *YAlign

func (*YAlign) UnmarshalJSON

func (e *YAlign) UnmarshalJSON(data []byte) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL