components

package
v1.0.1 Latest Latest
Warning

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

Go to latest
Published: Oct 12, 2025 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessPolicy added in v1.0.0

type AccessPolicy string

AccessPolicy - Access policy for media content

const (
	AccessPolicyPublic  AccessPolicy = "public"
	AccessPolicyPrivate AccessPolicy = "private"
	AccessPolicyDrm     AccessPolicy = "drm"
)

func (AccessPolicy) ToPointer added in v1.0.0

func (e AccessPolicy) ToPointer() *AccessPolicy

func (*AccessPolicy) UnmarshalJSON added in v1.0.0

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

type AddTrackRequest added in v1.0.0

type AddTrackRequest struct {
	// The direct URL of the track file. It should point to a valid audio or subtitle file.
	URL *string `json:"url,omitempty"`
	// Specifies the type of track being added. It can be either `audio` or `subtitle`.
	Type *AddTrackRequestType `json:"type,omitempty"`
	// The BCP 47 language code representing the track's language.
	LanguageCode *string `json:"languageCode,omitempty"`
	// The full name of the language corresponding to the `languageCode`.
	LanguageName *string `json:"languageName,omitempty"`
}

AddTrackRequest - Contains details about the track being added to the media file.

func (*AddTrackRequest) GetLanguageCode added in v1.0.0

func (a *AddTrackRequest) GetLanguageCode() *string

func (*AddTrackRequest) GetLanguageName added in v1.0.0

func (a *AddTrackRequest) GetLanguageName() *string

func (*AddTrackRequest) GetType added in v1.0.0

func (a *AddTrackRequest) GetType() *AddTrackRequestType

func (*AddTrackRequest) GetURL added in v1.0.0

func (a *AddTrackRequest) GetURL() *string

type AddTrackRequestType added in v1.0.0

type AddTrackRequestType string

AddTrackRequestType - Specifies the type of track being added. It can be either `audio` or `subtitle`.

const (
	AddTrackRequestTypeAudio    AddTrackRequestType = "audio"
	AddTrackRequestTypeSubtitle AddTrackRequestType = "subtitle"
)

func (AddTrackRequestType) ToPointer added in v1.0.0

func (*AddTrackRequestType) UnmarshalJSON added in v1.0.0

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

type AddTrackResponse added in v1.0.0

type AddTrackResponse struct {
	// The unique identifier of the track.
	ID *string `json:"id,omitempty"`
	// Specifies the type of track (audio or subtitle).
	Type *AddTrackResponseType `json:"type,omitempty"`
	// The direct URL of the track file.
	URL *string `json:"url,omitempty"`
	// The BCP 47 language code representing the track's language.
	LanguageCode *string `json:"languageCode,omitempty"`
	// The full name of the language corresponding to the `languageCode`.
	LanguageName *string `json:"languageName,omitempty"`
}

AddTrackResponse - Contains details about the track that was added or updated.

func (*AddTrackResponse) GetID added in v1.0.0

func (a *AddTrackResponse) GetID() *string

func (*AddTrackResponse) GetLanguageCode added in v1.0.0

func (a *AddTrackResponse) GetLanguageCode() *string

func (*AddTrackResponse) GetLanguageName added in v1.0.0

func (a *AddTrackResponse) GetLanguageName() *string

func (*AddTrackResponse) GetType added in v1.0.0

func (a *AddTrackResponse) GetType() *AddTrackResponseType

func (*AddTrackResponse) GetURL added in v1.0.0

func (a *AddTrackResponse) GetURL() *string

type AddTrackResponseType added in v1.0.0

type AddTrackResponseType string

AddTrackResponseType - Specifies the type of track (audio or subtitle).

const (
	AddTrackResponseTypeAudio    AddTrackResponseType = "audio"
	AddTrackResponseTypeSubtitle AddTrackResponseType = "subtitle"
)

func (AddTrackResponseType) ToPointer added in v1.0.0

func (*AddTrackResponseType) UnmarshalJSON added in v1.0.0

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

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 (a *AudioInput) GetImposeTracks() []ImposeTrack

func (*AudioInput) GetSwapTrackURL

func (a *AudioInput) GetSwapTrackURL() *string

func (*AudioInput) GetType

func (a *AudioInput) GetType() *AudioInputType

func (AudioInput) MarshalJSON added in v1.0.0

func (a AudioInput) MarshalJSON() ([]byte, error)

func (*AudioInput) UnmarshalJSON added in v1.0.0

func (a *AudioInput) UnmarshalJSON(data []byte) error

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 (b *BadRequestError) GetCode() *float64

func (*BadRequestError) GetDescription

func (b *BadRequestError) GetDescription() *string

func (*BadRequestError) GetMessage

func (b *BadRequestError) GetMessage() *string

type BasicAccessPolicy added in v1.0.0

type BasicAccessPolicy string

BasicAccessPolicy - Basic access policy for media content

const (
	BasicAccessPolicyPublic  BasicAccessPolicy = "public"
	BasicAccessPolicyPrivate BasicAccessPolicy = "private"
)

func (BasicAccessPolicy) ToPointer added in v1.0.0

func (e BasicAccessPolicy) ToPointer() *BasicAccessPolicy

func (*BasicAccessPolicy) UnmarshalJSON added in v1.0.0

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

type BrowserNameDimensiondetails added in v1.0.0

type BrowserNameDimensiondetails struct {
	// The specific metric value calculated based on the applied filters.
	Value string `json:"value"`
	// The count of unique viewers who interacted with the content.
	UniqueCount *int64 `json:"uniqueCount,omitempty"`
	// The count of viewers.
	Count int64 `json:"count"`
}

func (*BrowserNameDimensiondetails) GetCount added in v1.0.0

func (b *BrowserNameDimensiondetails) GetCount() int64

func (*BrowserNameDimensiondetails) GetUniqueCount added in v1.0.0

func (b *BrowserNameDimensiondetails) GetUniqueCount() *int64

func (*BrowserNameDimensiondetails) GetValue added in v1.0.0

func (b *BrowserNameDimensiondetails) GetValue() string

type ChaptersResponse added in v1.0.0

type ChaptersResponse struct {
	MediaID             *string `json:"mediaId,omitempty"`
	IsGeneratedChapters *bool   `json:"isGeneratedChapters,omitempty"`
}

func (*ChaptersResponse) GetIsGeneratedChapters added in v1.0.0

func (c *ChaptersResponse) GetIsGeneratedChapters() *bool

func (*ChaptersResponse) GetMediaID added in v1.0.0

func (c *ChaptersResponse) GetMediaID() *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 (c *CreateLiveStreamRequest) GetInputMediaSettings() InputMediaSettings

func (*CreateLiveStreamRequest) GetPlaybackSettings

func (c *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 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 maximum of 255 characters and upto 10 entries are allowed.
	Metadata map[string]string `json:"metadata,omitempty"`
	// Generates subtitle files for audio/video files.
	//
	Subtitles *Subtitles `json:"subtitles,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 (c *CreateMediaRequest) GetAccessRestrictions() *CreateMediaRequestAccessRestrictions

func (*CreateMediaRequest) GetChapters

func (c *CreateMediaRequest) GetChapters() *bool

func (*CreateMediaRequest) GetInputs

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

func (*CreateMediaRequest) GetMaxResolution

func (c *CreateMediaRequest) GetMaxResolution() *CreateMediaRequestMaxResolution

func (*CreateMediaRequest) GetMetadata

func (c *CreateMediaRequest) GetMetadata() map[string]string

func (*CreateMediaRequest) GetModeration

func (c *CreateMediaRequest) GetModeration() *Moderation

func (*CreateMediaRequest) GetMp4Support

func (*CreateMediaRequest) GetNamedEntities

func (c *CreateMediaRequest) GetNamedEntities() *bool

func (*CreateMediaRequest) GetOptimizeAudio

func (c *CreateMediaRequest) GetOptimizeAudio() *bool

func (*CreateMediaRequest) GetSourceAccess

func (c *CreateMediaRequest) GetSourceAccess() *bool

func (*CreateMediaRequest) GetSubtitles added in v1.0.0

func (c *CreateMediaRequest) GetSubtitles() *Subtitles

func (*CreateMediaRequest) GetSummary

func (c *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 {
	// Policy action type
	DefaultPolicy *PolicyAction `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 (c *CreateMediaRequestDomains) GetAllow() []string

func (*CreateMediaRequestDomains) GetDefaultPolicy

func (c *CreateMediaRequestDomains) GetDefaultPolicy() *PolicyAction

func (*CreateMediaRequestDomains) GetDeny

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

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 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 CreateMediaRequestUserAgents

type CreateMediaRequestUserAgents struct {
	// Policy action type
	DefaultPolicy *PolicyAction `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 (c *CreateMediaRequestUserAgents) GetAllow() []string

func (*CreateMediaRequestUserAgents) GetDefaultPolicy

func (c *CreateMediaRequestUserAgents) GetDefaultPolicy() *PolicyAction

func (*CreateMediaRequestUserAgents) GetDeny

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

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 map[string]string `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 (c *CreateMediaResponse) GetCreatedAt() *time.Time

func (*CreateMediaResponse) GetID

func (c *CreateMediaResponse) GetID() *string

func (*CreateMediaResponse) GetMaxResolution

func (*CreateMediaResponse) GetMetadata

func (c *CreateMediaResponse) GetMetadata() map[string]string

func (*CreateMediaResponse) GetPlaybackIds

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

func (*CreateMediaResponse) GetStatus

func (c *CreateMediaResponse) GetStatus() *string

func (*CreateMediaResponse) GetTrial

func (c *CreateMediaResponse) GetTrial() *bool

func (*CreateMediaResponse) GetUpdatedAt

func (c *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 CreateMediaSuccessResponse added in v1.0.0

type CreateMediaSuccessResponse struct {
	// Demonstrates whether the request is successful or not.
	Success bool                `json:"success"`
	Data    CreateMediaResponse `json:"data"`
}

func (*CreateMediaSuccessResponse) GetData added in v1.0.0

func (*CreateMediaSuccessResponse) GetSuccess added in v1.0.0

func (c *CreateMediaSuccessResponse) GetSuccess() bool

type CreatePlaylistRequest added in v1.0.0

type CreatePlaylistRequest struct {
	// Name of the playlist.
	Name string `json:"name"`
	// Unique string value assigned by user to the playlist.
	ReferenceID string `json:"referenceId"`
	// For a smart playlist metadata is required.
	Type CreatePlaylistRequestType `json:"type"`
	// Description for a playlist (Optional).
	Description *string `json:"description,omitempty"`
	// Determines the insertion order of media into playlist.
	PlayOrder *PlaylistOrder `json:"playOrder,omitempty"`
	// Optional parameter to limit no. of media in a playlist.
	Limit *int64 `default:"1000" json:"limit"`
	// Required when playlist type is smart - media created between startDate and endDate of createdDate will be add, similarily updatedDate (Optional)
	Metadata *CreatePlaylistRequestMetadata `json:"metadata,omitempty"`
}

func (*CreatePlaylistRequest) GetDescription added in v1.0.0

func (c *CreatePlaylistRequest) GetDescription() *string

func (*CreatePlaylistRequest) GetLimit added in v1.0.0

func (c *CreatePlaylistRequest) GetLimit() *int64

func (*CreatePlaylistRequest) GetMetadata added in v1.0.0

func (*CreatePlaylistRequest) GetName added in v1.0.0

func (c *CreatePlaylistRequest) GetName() string

func (*CreatePlaylistRequest) GetPlayOrder added in v1.0.0

func (c *CreatePlaylistRequest) GetPlayOrder() *PlaylistOrder

func (*CreatePlaylistRequest) GetReferenceID added in v1.0.0

func (c *CreatePlaylistRequest) GetReferenceID() string

func (*CreatePlaylistRequest) GetType added in v1.0.0

func (CreatePlaylistRequest) MarshalJSON added in v1.0.0

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

func (*CreatePlaylistRequest) UnmarshalJSON added in v1.0.0

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

type CreatePlaylistRequestMetadata added in v1.0.0

type CreatePlaylistRequestMetadata struct {
	// Date range with start and end dates.
	CreatedDate *DateRange `json:"createdDate,omitempty"`
	// Date range with start and end dates.
	UpdatedDate *DateRange `json:"updatedDate,omitempty"`
}

CreatePlaylistRequestMetadata - Required when playlist type is smart - media created between startDate and endDate of createdDate will be add, similarily updatedDate (Optional)

func (*CreatePlaylistRequestMetadata) GetCreatedDate added in v1.0.0

func (c *CreatePlaylistRequestMetadata) GetCreatedDate() *DateRange

func (*CreatePlaylistRequestMetadata) GetUpdatedDate added in v1.0.0

func (c *CreatePlaylistRequestMetadata) GetUpdatedDate() *DateRange

type CreatePlaylistRequestType added in v1.0.0

type CreatePlaylistRequestType string

CreatePlaylistRequestType - For a smart playlist metadata is required.

const (
	CreatePlaylistRequestTypeSmart  CreatePlaylistRequestType = "smart"
	CreatePlaylistRequestTypeManual CreatePlaylistRequestType = "manual"
)

func (CreatePlaylistRequestType) ToPointer added in v1.0.0

func (*CreatePlaylistRequestType) UnmarshalJSON added in v1.0.0

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

type CreateResponse added in v1.0.0

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

func (*CreateResponse) GetData added in v1.0.0

func (*CreateResponse) GetSuccess added in v1.0.0

func (c *CreateResponse) GetSuccess() *bool

type CreateSigningKeyResponseDTO added in v1.0.0

type CreateSigningKeyResponseDTO struct {
	// A unique identifier is generated by FastPix for the signing keys.
	ID *string `json:"id,omitempty"`
	// A private key is a byte encoded secret key used to create a signed JSON Web Token (JWT) for authentication.
	PrivateKey *string `json:"privateKey,omitempty"`
	// Time the media was generated, defined as a localDateTime (UTC Time).
	CreatedAt *time.Time `json:"createdAt,omitempty"`
}

CreateSigningKeyResponseDTO - Displays the result of the request.

func (*CreateSigningKeyResponseDTO) GetCreatedAt added in v1.0.0

func (c *CreateSigningKeyResponseDTO) GetCreatedAt() *time.Time

func (*CreateSigningKeyResponseDTO) GetID added in v1.0.0

func (c *CreateSigningKeyResponseDTO) GetID() *string

func (*CreateSigningKeyResponseDTO) GetPrivateKey added in v1.0.0

func (c *CreateSigningKeyResponseDTO) GetPrivateKey() *string

func (CreateSigningKeyResponseDTO) MarshalJSON added in v1.0.0

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

func (*CreateSigningKeyResponseDTO) UnmarshalJSON added in v1.0.0

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

type DataPagination added in v1.0.0

type DataPagination struct {
	// The total number of records retrieved within the timeframe.
	//
	TotalRecords *int64 `json:"totalRecords,omitempty"`
	// The current offset value.
	//
	// Default: 1
	//
	CurrentOffset *int64 `json:"currentOffset,omitempty"`
	// The total number of offsets based on limit.
	//
	OffsetCount *int64 `json:"offsetCount,omitempty"`
}

DataPagination - Pagination organizes content into pages for better readability and navigation.

func (*DataPagination) GetCurrentOffset added in v1.0.0

func (d *DataPagination) GetCurrentOffset() *int64

func (*DataPagination) GetOffsetCount added in v1.0.0

func (d *DataPagination) GetOffsetCount() *int64

func (*DataPagination) GetTotalRecords added in v1.0.0

func (d *DataPagination) GetTotalRecords() *int64

type DateRange added in v1.0.0

type DateRange struct {
	StartDate *string `json:"startDate,omitempty"`
	EndDate   *string `json:"endDate,omitempty"`
}

DateRange - Date range with start and end dates.

func (*DateRange) GetEndDate added in v1.0.0

func (d *DateRange) GetEndDate() *string

func (*DateRange) GetStartDate added in v1.0.0

func (d *DateRange) GetStartDate() *string

type DeleteSigningKeyResponse added in v1.0.0

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

func (*DeleteSigningKeyResponse) GetSuccess added in v1.0.0

func (d *DeleteSigningKeyResponse) GetSuccess() *bool

type Details added in v1.0.0

type Details struct {
	// The player_source_bitrate represents the bitrate of the video stream that is being played, measured in bits per second (bps). This value indicates the quality of the video being streamed, with higher bitrates typically corresponding to better video quality but requiring more bandwidth.
	//
	PlayerSourceBitrate optionalnullable.OptionalNullable[int64] `json:"player_source_bitrate,omitempty"`
	// The player_source_codec represents the video or audio codec being used to decode and play the media. A codec is a technology used to compress and decompress digital media files, enabling efficient transmission and storage while maintaining quality.
	//
	PlayerSourceCodec optionalnullable.OptionalNullable[string] `json:"player_source_codec,omitempty"`
	// The player_source_height refers to the vertical resolution of the video being played, measured in pixels. This value represents the height dimension of the video frame and is part of the overall resolution of the video (e.g., 1920x1080, where the height is 1080 pixels).
	//
	PlayerSourceHeight optionalnullable.OptionalNullable[int64] `json:"playerSourceHeight,omitempty"`
	// The player_source_width refers to the horizontal resolution of the video being played, measured in pixels. This value represents the width dimension of the video frame and is part of the overall video resolution (e.g., 1920x1080, where the width is 1920 pixels).
	//
	PlayerSourceWidth optionalnullable.OptionalNullable[int64] `json:"playerSourceWidth,omitempty"`
}

func (*Details) GetPlayerSourceBitrate added in v1.0.0

func (d *Details) GetPlayerSourceBitrate() optionalnullable.OptionalNullable[int64]

func (*Details) GetPlayerSourceCodec added in v1.0.0

func (d *Details) GetPlayerSourceCodec() optionalnullable.OptionalNullable[string]

func (*Details) GetPlayerSourceHeight added in v1.0.0

func (d *Details) GetPlayerSourceHeight() optionalnullable.OptionalNullable[int64]

func (*Details) GetPlayerSourceWidth added in v1.0.0

func (d *Details) GetPlayerSourceWidth() optionalnullable.OptionalNullable[int64]

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 (d *DirectUpload) GetCorsOrigin() *string

func (*DirectUpload) GetID

func (d *DirectUpload) GetID() *string

func (*DirectUpload) GetMediaID

func (d *DirectUpload) GetMediaID() *string

func (*DirectUpload) GetPushMediaSettings

func (d *DirectUpload) GetPushMediaSettings() *DirectUploadResponse

func (*DirectUpload) GetStatus

func (d *DirectUpload) GetStatus() *string

func (*DirectUpload) GetTimeout

func (d *DirectUpload) GetTimeout() *float64

func (*DirectUpload) GetURL

func (d *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 map[string]string `json:"metadata,omitempty"`
}

func (*DirectUploadResponse) GetMetadata

func (d *DirectUploadResponse) GetMetadata() map[string]string

func (*DirectUploadResponse) GetPlaybackIds

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

type DomainRestrictions added in v1.0.0

type DomainRestrictions struct {
	// Policy action type
	DefaultPolicy *PolicyAction `json:"defaultPolicy,omitempty"`
	// A list of domain names or patterns that are explicitly allowed access
	Allow []string `json:"allow,omitempty"`
	// A list of domain names or patterns that are explicitly denied access
	Deny []string `json:"deny,omitempty"`
}

DomainRestrictions - Restrictions based on the originating domain of a request

func (*DomainRestrictions) GetAllow added in v1.0.0

func (d *DomainRestrictions) GetAllow() []string

func (*DomainRestrictions) GetDefaultPolicy added in v1.0.0

func (d *DomainRestrictions) GetDefaultPolicy() *PolicyAction

func (*DomainRestrictions) GetDeny added in v1.0.0

func (d *DomainRestrictions) GetDeny() []string

type DrmIDResponse added in v1.0.0

type DrmIDResponse struct {
	// The unique identifier of the DRM configuration.
	ID *string `json:"id,omitempty"`
}

func (*DrmIDResponse) GetID added in v1.0.0

func (d *DrmIDResponse) GetID() *string

type DuplicateMp4SupportError added in v1.0.0

type DuplicateMp4SupportError 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"`
}

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

func (*DuplicateMp4SupportError) GetCode added in v1.0.0

func (d *DuplicateMp4SupportError) GetCode() *float64

func (*DuplicateMp4SupportError) GetDescription added in v1.0.0

func (d *DuplicateMp4SupportError) GetDescription() *string

func (*DuplicateMp4SupportError) GetMessage added in v1.0.0

func (d *DuplicateMp4SupportError) GetMessage() *string

type DuplicateReferenceIDErrorResponseError added in v1.0.0

type DuplicateReferenceIDErrorResponseError 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"`
}

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

func (*DuplicateReferenceIDErrorResponseError) GetCode added in v1.0.0

func (*DuplicateReferenceIDErrorResponseError) GetDescription added in v1.0.0

func (d *DuplicateReferenceIDErrorResponseError) GetDescription() *string

func (*DuplicateReferenceIDErrorResponseError) GetMessage added in v1.0.0

type ErrorDetails added in v1.0.0

type ErrorDetails struct {
	// views affected by the specific errors.
	Percentage optionalnullable.OptionalNullable[ErrorDetailsPercentage] `json:"percentage,omitempty"`
	// Information about the specific error.
	Notes optionalnullable.OptionalNullable[string] `json:"notes,omitempty"`
	// error message or description.
	Message optionalnullable.OptionalNullable[string] `json:"message,omitempty"`
	// The timestamp of when the error was last observed.
	LastSeen optionalnullable.OptionalNullable[string] `json:"lastSeen,omitempty"`
	// unique identifier for the specific error.
	ID optionalnullable.OptionalNullable[string] `json:"id,omitempty"`
	// description of the specific error.
	Description optionalnullable.OptionalNullable[string] `json:"description,omitempty"`
	// Number of occurrences of the specific error.
	Count optionalnullable.OptionalNullable[int64] `json:"count,omitempty"`
	// Error code associated with the specific error.
	Code optionalnullable.OptionalNullable[string] `json:"code,omitempty"`
}

func (*ErrorDetails) GetCode added in v1.0.0

func (*ErrorDetails) GetCount added in v1.0.0

func (*ErrorDetails) GetDescription added in v1.0.0

func (*ErrorDetails) GetID added in v1.0.0

func (*ErrorDetails) GetLastSeen added in v1.0.0

func (*ErrorDetails) GetMessage added in v1.0.0

func (*ErrorDetails) GetNotes added in v1.0.0

func (*ErrorDetails) GetPercentage added in v1.0.0

type ErrorDetailsPercentage added in v1.0.0

type ErrorDetailsPercentage struct {
	Integer *int64   `queryParam:"inline,name=percentage"`
	Number  *float64 `queryParam:"inline,name=percentage"`

	Type ErrorDetailsPercentageType
}

ErrorDetailsPercentage - views affected by the specific errors.

func CreateErrorDetailsPercentageInteger added in v1.0.0

func CreateErrorDetailsPercentageInteger(integer int64) ErrorDetailsPercentage

func CreateErrorDetailsPercentageNumber added in v1.0.0

func CreateErrorDetailsPercentageNumber(number float64) ErrorDetailsPercentage

func (ErrorDetailsPercentage) MarshalJSON added in v1.0.0

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

func (*ErrorDetailsPercentage) UnmarshalJSON added in v1.0.0

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

type ErrorDetailsPercentageType added in v1.0.0

type ErrorDetailsPercentageType string
const (
	ErrorDetailsPercentageTypeInteger ErrorDetailsPercentageType = "integer"
	ErrorDetailsPercentageTypeNumber  ErrorDetailsPercentageType = "number"
)

type Event added in v1.0.0

type Event struct {
	// Name of the event.
	//
	EventName optionalnullable.OptionalNullable[string] `json:"event_name,omitempty"`
	// The unix epoch timestamp when the event was captured.
	//
	EventTime optionalnullable.OptionalNullable[EventTime] `json:"event_time,omitempty"`
	// The unix epoch timestamp which represents the actual time the event has occured.
	//
	ViewerTime optionalnullable.OptionalNullable[int64] `json:"viewer_time,omitempty"`
	// The player_playhead_time represents the current position of the playhead (the point in the video that is being watched) on the video seekbar, measured in milliseconds. This value indicates how far into the video playback has progressed at any given moment.
	//
	PlayerPlayheadTime optionalnullable.OptionalNullable[int64] `json:"player_playhead_time,omitempty"`
	Details            *Details                                 `json:"details,omitempty"`
}

func (*Event) GetDetails added in v1.0.0

func (e *Event) GetDetails() *Details

func (*Event) GetEventName added in v1.0.0

func (e *Event) GetEventName() optionalnullable.OptionalNullable[string]

func (*Event) GetEventTime added in v1.0.0

func (e *Event) GetEventTime() optionalnullable.OptionalNullable[EventTime]

func (*Event) GetPlayerPlayheadTime added in v1.0.0

func (e *Event) GetPlayerPlayheadTime() optionalnullable.OptionalNullable[int64]

func (*Event) GetViewerTime added in v1.0.0

func (e *Event) GetViewerTime() optionalnullable.OptionalNullable[int64]

type EventTime added in v1.0.0

type EventTime struct {
	Str     *string `queryParam:"inline,name=event_time"`
	Integer *int64  `queryParam:"inline,name=event_time"`

	Type EventTimeType
}

EventTime - The unix epoch timestamp when the event was captured.

func CreateEventTimeInteger added in v1.0.0

func CreateEventTimeInteger(integer int64) EventTime

func CreateEventTimeStr added in v1.0.0

func CreateEventTimeStr(str string) EventTime

func (EventTime) MarshalJSON added in v1.0.0

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

func (*EventTime) UnmarshalJSON added in v1.0.0

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

type EventTimeType added in v1.0.0

type EventTimeType string
const (
	EventTimeTypeStr     EventTimeType = "str"
	EventTimeTypeInteger EventTimeType = "integer"
)

type FieldError added in v1.0.0

type FieldError struct {
	// Displays the specific field associated with the error.
	Field string `json:"field"`
	// Error message for the field
	Message string `json:"message"`
}

func (*FieldError) GetField added in v1.0.0

func (f *FieldError) GetField() string

func (*FieldError) GetMessage added in v1.0.0

func (f *FieldError) GetMessage() string

type ForbiddenError

type ForbiddenError 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"`
}

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

func (*ForbiddenError) GetCode

func (f *ForbiddenError) GetCode() *float64

func (*ForbiddenError) GetDescription

func (f *ForbiddenError) GetDescription() *string

func (*ForbiddenError) GetMessage

func (f *ForbiddenError) GetMessage() *string

type ForbiddenResponseError added in v1.0.0

type ForbiddenResponseError struct {
	// Forbidden response
	Code *int64 `json:"code,omitempty"`
	// A descriptive message providing more details for the error.
	Message *string `json:"message,omitempty"`
}

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

func (*ForbiddenResponseError) GetCode added in v1.0.0

func (f *ForbiddenResponseError) GetCode() *int64

func (*ForbiddenResponseError) GetMessage added in v1.0.0

func (f *ForbiddenResponseError) GetMessage() *string

type GenerateTrackResponse added in v1.0.0

type GenerateTrackResponse struct {
	// A unique identifier for the generated track.
	ID *string `json:"id,omitempty"`
	// The type of track generated ("subtitle").
	Type *GenerateTrackResponseType `json:"type,omitempty"`
	// The BCP 47 language code representing the language of the generated track.
	//
	LanguageCode *GenerateTrackResponseLanguageCode `json:"languageCode,omitempty"`
	// The full name of the language for the generated track.
	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 maximum of 255 characters and upto 10 entries are allowed.
	Metadata map[string]string `json:"metadata,omitempty"`
}

GenerateTrackResponse - Represents the response for a successfully generated subtitle track.

func (*GenerateTrackResponse) GetID added in v1.0.0

func (g *GenerateTrackResponse) GetID() *string

func (*GenerateTrackResponse) GetLanguageCode added in v1.0.0

func (*GenerateTrackResponse) GetLanguageName added in v1.0.0

func (g *GenerateTrackResponse) GetLanguageName() *string

func (*GenerateTrackResponse) GetMetadata added in v1.0.0

func (g *GenerateTrackResponse) GetMetadata() map[string]string

func (*GenerateTrackResponse) GetType added in v1.0.0

type GenerateTrackResponseLanguageCode added in v1.0.0

type GenerateTrackResponseLanguageCode string

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

const (
	GenerateTrackResponseLanguageCodeArSa GenerateTrackResponseLanguageCode = "ar-SA"
	GenerateTrackResponseLanguageCodeBnBd GenerateTrackResponseLanguageCode = "bn-BD"
	GenerateTrackResponseLanguageCodeBnIn GenerateTrackResponseLanguageCode = "bn-IN"
	GenerateTrackResponseLanguageCodeCaEs GenerateTrackResponseLanguageCode = "ca-ES"
	GenerateTrackResponseLanguageCodeCsCz GenerateTrackResponseLanguageCode = "cs-CZ"
	GenerateTrackResponseLanguageCodeDaDk GenerateTrackResponseLanguageCode = "da-DK"
	GenerateTrackResponseLanguageCodeDeAt GenerateTrackResponseLanguageCode = "de-AT"
	GenerateTrackResponseLanguageCodeDeCh GenerateTrackResponseLanguageCode = "de-CH"
	GenerateTrackResponseLanguageCodeDeDe GenerateTrackResponseLanguageCode = "de-DE"
	GenerateTrackResponseLanguageCodeElGr GenerateTrackResponseLanguageCode = "el-GR"
	GenerateTrackResponseLanguageCodeEnAu GenerateTrackResponseLanguageCode = "en-AU"
	GenerateTrackResponseLanguageCodeEnCa GenerateTrackResponseLanguageCode = "en-CA"
	GenerateTrackResponseLanguageCodeEnGb GenerateTrackResponseLanguageCode = "en-GB"
	GenerateTrackResponseLanguageCodeEnIe GenerateTrackResponseLanguageCode = "en-IE"
	GenerateTrackResponseLanguageCodeEnIn GenerateTrackResponseLanguageCode = "en-IN"
	GenerateTrackResponseLanguageCodeEnNz GenerateTrackResponseLanguageCode = "en-NZ"
	GenerateTrackResponseLanguageCodeEnUs GenerateTrackResponseLanguageCode = "en-US"
	GenerateTrackResponseLanguageCodeEnZa GenerateTrackResponseLanguageCode = "en-ZA"
	GenerateTrackResponseLanguageCodeEsAr GenerateTrackResponseLanguageCode = "es-AR"
	GenerateTrackResponseLanguageCodeEsCl GenerateTrackResponseLanguageCode = "es-CL"
	GenerateTrackResponseLanguageCodeEsCo GenerateTrackResponseLanguageCode = "es-CO"
	GenerateTrackResponseLanguageCodeEsEs GenerateTrackResponseLanguageCode = "es-ES"
	GenerateTrackResponseLanguageCodeEsMx GenerateTrackResponseLanguageCode = "es-MX"
	GenerateTrackResponseLanguageCodeEsUs GenerateTrackResponseLanguageCode = "es-US"
	GenerateTrackResponseLanguageCodeFiFi GenerateTrackResponseLanguageCode = "fi-FI"
	GenerateTrackResponseLanguageCodeFrBe GenerateTrackResponseLanguageCode = "fr-BE"
	GenerateTrackResponseLanguageCodeFrCa GenerateTrackResponseLanguageCode = "fr-CA"
	GenerateTrackResponseLanguageCodeFrCh GenerateTrackResponseLanguageCode = "fr-CH"
	GenerateTrackResponseLanguageCodeFrFr GenerateTrackResponseLanguageCode = "fr-FR"
	GenerateTrackResponseLanguageCodeHeIl GenerateTrackResponseLanguageCode = "he-IL"
	GenerateTrackResponseLanguageCodeHiIn GenerateTrackResponseLanguageCode = "hi-IN"
	GenerateTrackResponseLanguageCodeHrHr GenerateTrackResponseLanguageCode = "hr-HR"
	GenerateTrackResponseLanguageCodeHuHu GenerateTrackResponseLanguageCode = "hu-HU"
	GenerateTrackResponseLanguageCodeIDID GenerateTrackResponseLanguageCode = "id-ID"
	GenerateTrackResponseLanguageCodeItCh GenerateTrackResponseLanguageCode = "it-CH"
	GenerateTrackResponseLanguageCodeItIt GenerateTrackResponseLanguageCode = "it-IT"
	GenerateTrackResponseLanguageCodeJaJp GenerateTrackResponseLanguageCode = "ja-JP"
	GenerateTrackResponseLanguageCodeKoKr GenerateTrackResponseLanguageCode = "ko-KR"
	GenerateTrackResponseLanguageCodeNlBe GenerateTrackResponseLanguageCode = "nl-BE"
	GenerateTrackResponseLanguageCodeNlNl GenerateTrackResponseLanguageCode = "nl-NL"
	GenerateTrackResponseLanguageCodeNoNo GenerateTrackResponseLanguageCode = "no-NO"
	GenerateTrackResponseLanguageCodePlPl GenerateTrackResponseLanguageCode = "pl-PL"
	GenerateTrackResponseLanguageCodePtBr GenerateTrackResponseLanguageCode = "pt-BR"
	GenerateTrackResponseLanguageCodePtPt GenerateTrackResponseLanguageCode = "pt-PT"
	GenerateTrackResponseLanguageCodeRoRo GenerateTrackResponseLanguageCode = "ro-RO"
	GenerateTrackResponseLanguageCodeRuRu GenerateTrackResponseLanguageCode = "ru-RU"
	GenerateTrackResponseLanguageCodeSkSk GenerateTrackResponseLanguageCode = "sk-SK"
	GenerateTrackResponseLanguageCodeSvSe GenerateTrackResponseLanguageCode = "sv-SE"
	GenerateTrackResponseLanguageCodeTaIn GenerateTrackResponseLanguageCode = "ta-IN"
	GenerateTrackResponseLanguageCodeTaLk GenerateTrackResponseLanguageCode = "ta-LK"
	GenerateTrackResponseLanguageCodeThTh GenerateTrackResponseLanguageCode = "th-TH"
	GenerateTrackResponseLanguageCodeTrTr GenerateTrackResponseLanguageCode = "tr-TR"
	GenerateTrackResponseLanguageCodeUkUa GenerateTrackResponseLanguageCode = "uk-UA"
	GenerateTrackResponseLanguageCodeBgBg GenerateTrackResponseLanguageCode = "bg-BG"
	GenerateTrackResponseLanguageCodeZhCn GenerateTrackResponseLanguageCode = "zh-CN"
	GenerateTrackResponseLanguageCodeZhHk GenerateTrackResponseLanguageCode = "zh-HK"
	GenerateTrackResponseLanguageCodeZhTw GenerateTrackResponseLanguageCode = "zh-TW"
)

func (GenerateTrackResponseLanguageCode) ToPointer added in v1.0.0

func (*GenerateTrackResponseLanguageCode) UnmarshalJSON added in v1.0.0

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

type GenerateTrackResponseType added in v1.0.0

type GenerateTrackResponseType string

GenerateTrackResponseType - The type of track generated ("subtitle").

const (
	GenerateTrackResponseTypeSubtitle GenerateTrackResponseType = "subtitle"
)

func (GenerateTrackResponseType) ToPointer added in v1.0.0

func (*GenerateTrackResponseType) UnmarshalJSON added in v1.0.0

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

type GeneratedSubtitle added in v1.0.0

type GeneratedSubtitle struct {
}

type GetAllPlaylistsResponse added in v1.0.0

type GetAllPlaylistsResponse struct {
	Success *bool          `json:"success,omitempty"`
	Data    []PlaylistItem `json:"data,omitempty"`
	// Pagination organizes content into pages for better readability and navigation.
	Pagination *Pagination `json:"pagination,omitempty"`
}

func (*GetAllPlaylistsResponse) GetData added in v1.0.0

func (g *GetAllPlaylistsResponse) GetData() []PlaylistItem

func (*GetAllPlaylistsResponse) GetPagination added in v1.0.0

func (g *GetAllPlaylistsResponse) GetPagination() *Pagination

func (*GetAllPlaylistsResponse) GetSuccess added in v1.0.0

func (g *GetAllPlaylistsResponse) GetSuccess() *bool

type GetAllSigningKeyResponse added in v1.0.0

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

func (*GetAllSigningKeyResponse) GetData added in v1.0.0

func (*GetAllSigningKeyResponse) GetSuccess added in v1.0.0

func (g *GetAllSigningKeyResponse) GetSuccess() *bool

type GetAllSigningKeyResponseDTO added in v1.0.0

type GetAllSigningKeyResponseDTO struct {
	// A unique identifier is generated by FastPix for the signing keys.
	ID *string `json:"id,omitempty"`
	// Time the media was generated, defined as a localDateTime (UTC Time).
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	// It display a specific setup where all operations are conducted.
	Workspace []SigningKeyWorkspaceDTO `json:"workspace,omitempty"`
	// Pagination organizes content into pages for better readability and navigation.
	Pagination *SingingKeysPagination `json:"pagination,omitempty"`
}

func (*GetAllSigningKeyResponseDTO) GetCreatedAt added in v1.0.0

func (g *GetAllSigningKeyResponseDTO) GetCreatedAt() *time.Time

func (*GetAllSigningKeyResponseDTO) GetID added in v1.0.0

func (g *GetAllSigningKeyResponseDTO) GetID() *string

func (*GetAllSigningKeyResponseDTO) GetPagination added in v1.0.0

func (*GetAllSigningKeyResponseDTO) GetWorkspace added in v1.0.0

func (GetAllSigningKeyResponseDTO) MarshalJSON added in v1.0.0

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

func (*GetAllSigningKeyResponseDTO) UnmarshalJSON added in v1.0.0

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

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 RTMPS 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, gets disrupted for any reason and gets disconnected from FastPix, the reconnect window specifies the time span FastPix will wait before ending the stream. Before starting the stream, you can set the reconnect window time 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 map[string]string `json:"metadata,omitempty"`
	// Enables DVR (Digital Video Recorder) functionality for the live stream. When set to true, viewers can pause, rewind, and resume playback during the live broadcast. This allows time-shifted viewing of the stream while it is still ongoing.
	EnableDvrMode *bool `json:"enableDvrMode,omitempty"`
	// A collection of Playback ID objects utilized for crafting HLS playback urls.
	PlaybackIds []PlaybackIDResponse `json:"playbackIds,omitempty"`
	// A set of media IDs created after the livestream ends. (live to VOD)
	MediaIds []string `json:"mediaIds,omitempty"`
	// This object contains the livestream playback response details for SRT Protocol
	SrtPlaybackResponse *SrtPlaybackResponse `json:"srtPlaybackResponse,omitempty"`
}

GetCreateLiveStreamResponseDTO - Displays the result of the request.

func (*GetCreateLiveStreamResponseDTO) GetCreatedAt

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

func (*GetCreateLiveStreamResponseDTO) GetEnableDvrMode added in v1.0.0

func (g *GetCreateLiveStreamResponseDTO) GetEnableDvrMode() *bool

func (*GetCreateLiveStreamResponseDTO) GetEnableRecording

func (g *GetCreateLiveStreamResponseDTO) GetEnableRecording() *bool

func (*GetCreateLiveStreamResponseDTO) GetMaxDuration

func (g *GetCreateLiveStreamResponseDTO) GetMaxDuration() *int64

func (*GetCreateLiveStreamResponseDTO) GetMaxResolution

func (g *GetCreateLiveStreamResponseDTO) GetMaxResolution() *string

func (*GetCreateLiveStreamResponseDTO) GetMediaIds added in v1.0.0

func (g *GetCreateLiveStreamResponseDTO) GetMediaIds() []string

func (*GetCreateLiveStreamResponseDTO) GetMediaPolicy

func (g *GetCreateLiveStreamResponseDTO) GetMediaPolicy() *string

func (*GetCreateLiveStreamResponseDTO) GetMetadata

func (g *GetCreateLiveStreamResponseDTO) GetMetadata() map[string]string

func (*GetCreateLiveStreamResponseDTO) GetPlaybackIds added in v1.0.0

func (g *GetCreateLiveStreamResponseDTO) GetPlaybackIds() []PlaybackIDResponse

func (*GetCreateLiveStreamResponseDTO) GetReconnectWindow

func (g *GetCreateLiveStreamResponseDTO) GetReconnectWindow() *int64

func (*GetCreateLiveStreamResponseDTO) GetSrtPlaybackResponse

func (g *GetCreateLiveStreamResponseDTO) GetSrtPlaybackResponse() *SrtPlaybackResponse

func (*GetCreateLiveStreamResponseDTO) GetSrtSecret

func (g *GetCreateLiveStreamResponseDTO) GetSrtSecret() *string

func (*GetCreateLiveStreamResponseDTO) GetStatus

func (g *GetCreateLiveStreamResponseDTO) GetStatus() *string

func (*GetCreateLiveStreamResponseDTO) GetStreamID

func (g *GetCreateLiveStreamResponseDTO) GetStreamID() *string

func (*GetCreateLiveStreamResponseDTO) GetStreamKey

func (g *GetCreateLiveStreamResponseDTO) GetStreamKey() *string

func (*GetCreateLiveStreamResponseDTO) GetTrial

func (g *GetCreateLiveStreamResponseDTO) GetTrial() *bool

func (GetCreateLiveStreamResponseDTO) MarshalJSON

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

func (*GetCreateLiveStreamResponseDTO) UnmarshalJSON

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

type GetPublicPemUsingSigningKeyIDResponseDTO added in v1.0.0

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

GetPublicPemUsingSigningKeyIDResponseDTO - Displays the result of the request.

func (*GetPublicPemUsingSigningKeyIDResponseDTO) GetData added in v1.0.0

func (*GetPublicPemUsingSigningKeyIDResponseDTO) GetSuccess added in v1.0.0

type GetPublicPemUsingSigningKeyIDResponseDTOData added in v1.0.0

type GetPublicPemUsingSigningKeyIDResponseDTOData struct {
	// FastPix generates a unique identifier for each workspace.
	WorkspaceID  *string `json:"workspaceId,omitempty"`
	SigningKeyID *string `json:"signingKeyId,omitempty"`
	// A public key is a byte encoded key used to create a signed JSON Web Token (JWT) for authentication.
	PublicKey *string `json:"publicKey,omitempty"`
}

GetPublicPemUsingSigningKeyIDResponseDTOData - Displays the result of the request.

func (*GetPublicPemUsingSigningKeyIDResponseDTOData) GetPublicKey added in v1.0.0

func (*GetPublicPemUsingSigningKeyIDResponseDTOData) GetSigningKeyID added in v1.0.0

func (*GetPublicPemUsingSigningKeyIDResponseDTOData) GetWorkspaceID added in v1.0.0

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 *LiveStreamPagination `json:"pagination,omitempty"`
}

GetStreamsResponse - Displays the result of the request.

func (*GetStreamsResponse) GetData

func (*GetStreamsResponse) GetPagination

func (g *GetStreamsResponse) GetPagination() *LiveStreamPagination

func (*GetStreamsResponse) GetSuccess

func (g *GetStreamsResponse) GetSuccess() *bool

type GlobalValue added in v1.0.0

type GlobalValue struct {
	Integer *int64   `queryParam:"inline,name=globalValue"`
	Number  *float64 `queryParam:"inline,name=globalValue"`

	Type GlobalValueType
}

GlobalValue - A global metric value that reflects the overall performance of the specified metric across the entire dataset for the given timespan.

func CreateGlobalValueInteger added in v1.0.0

func CreateGlobalValueInteger(integer int64) GlobalValue

func CreateGlobalValueNumber added in v1.0.0

func CreateGlobalValueNumber(number float64) GlobalValue

func (GlobalValue) MarshalJSON added in v1.0.0

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

func (*GlobalValue) UnmarshalJSON added in v1.0.0

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

type GlobalValueType added in v1.0.0

type GlobalValueType string
const (
	GlobalValueTypeInteger GlobalValueType = "integer"
	GlobalValueTypeNumber  GlobalValueType = "number"
)

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 (h *HTTPMetadata) GetRequest() *http.Request

func (*HTTPMetadata) GetResponse

func (h *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 (i *ImposeTrack) GetEndTime() *int64

func (*ImposeTrack) GetFadeInLevel

func (i *ImposeTrack) GetFadeInLevel() *int64

func (*ImposeTrack) GetFadeOutLevel

func (i *ImposeTrack) GetFadeOutLevel() *int64

func (*ImposeTrack) GetStartTime

func (i *ImposeTrack) GetStartTime() *int64

func (*ImposeTrack) GetURL

func (i *ImposeTrack) GetURL() *string

func (ImposeTrack) MarshalJSON added in v1.0.0

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

func (*ImposeTrack) UnmarshalJSON added in v1.0.0

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

type Input

type Input struct {
	VideoInput     *VideoInput     `queryParam:"inline,name=input"`
	WatermarkInput *WatermarkInput `queryParam:"inline,name=input"`
	AudioInput     *AudioInput     `queryParam:"inline,name=input"`
	SubtitleInput  *SubtitleInput  `queryParam:"inline,name=input"`

	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, gets disrupted for any reason and gets disconnected from FastPix, the reconnect window specifies the time span FastPix will wait before ending the stream. Before starting the stream, you can set the reconnect window time which is up to 1800 seconds.
	ReconnectWindow *int64 `default:"60" json:"reconnectWindow"`
	// Basic access policy for media content
	MediaPolicy *BasicAccessPolicy `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 map[string]string `json:"metadata,omitempty"`
	// Enables DVR (Digital Video Recorder) functionality for the live stream. When set to true, viewers can pause, rewind, and resume playback during the live broadcast. This allows time-shifted viewing of the stream while it is still ongoing.
	EnableDvrMode *bool `json:"enableDvrMode,omitempty"`
}

InputMediaSettings - Displays the result of the input Media settings.

func (*InputMediaSettings) GetEnableDvrMode added in v1.0.0

func (i *InputMediaSettings) GetEnableDvrMode() *bool

func (*InputMediaSettings) GetMaxResolution

func (*InputMediaSettings) GetMediaPolicy

func (i *InputMediaSettings) GetMediaPolicy() *BasicAccessPolicy

func (*InputMediaSettings) GetMetadata

func (i *InputMediaSettings) GetMetadata() map[string]string

func (*InputMediaSettings) GetReconnectWindow

func (i *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 (i *InvalidPermissionError) GetCode() *int64

func (*InvalidPermissionError) GetDescription

func (i *InvalidPermissionError) GetDescription() *string

func (*InvalidPermissionError) GetMessage

func (i *InvalidPermissionError) GetMessage() *string

type InvalidPlaylistIDResponseError added in v1.0.0

type InvalidPlaylistIDResponseError 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"`
	// It is an collection of objects, where each object contains information about a specific field and a corresponding error message.
	Fields []FieldError `json:"fields,omitempty"`
}

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

func (*InvalidPlaylistIDResponseError) GetCode added in v1.0.0

func (i *InvalidPlaylistIDResponseError) GetCode() *int64

func (*InvalidPlaylistIDResponseError) GetFields added in v1.0.0

func (i *InvalidPlaylistIDResponseError) GetFields() []FieldError

func (*InvalidPlaylistIDResponseError) GetMessage added in v1.0.0

func (i *InvalidPlaylistIDResponseError) GetMessage() *string

type Item added in v1.0.0

type Item struct {
	// The specific metric value calculated based on the applied filters.
	Value *int64 `json:"value,omitempty"`
	// value can be score that ranges from 0 to 100
	Type *string `json:"type,omitempty"`
	// value can be score that ranges from 0 to 100
	Name *string `json:"name,omitempty"`
	// The metric field represents the name of the Key Performance Indicator (KPI) being tracked or analyzed. It identifies a specific measurable aspect of the video playback experience, such as buffering time, video start failure rate, or playback quality.
	//
	Metric *string `json:"metric,omitempty"`
	// value can be avg, sum, count or 95th
	Measurement *string `json:"measurement,omitempty"`
}

func (*Item) GetMeasurement added in v1.0.0

func (i *Item) GetMeasurement() *string

func (*Item) GetMetric added in v1.0.0

func (i *Item) GetMetric() *string

func (*Item) GetName added in v1.0.0

func (i *Item) GetName() *string

func (*Item) GetType added in v1.0.0

func (i *Item) GetType() *string

func (*Item) GetValue added in v1.0.0

func (i *Item) GetValue() *int64

type LanguageCode added in v1.0.0

type LanguageCode string

LanguageCode - Language code for content localization

const (
	LanguageCodeArSa LanguageCode = "ar-SA"
	LanguageCodeBnBd LanguageCode = "bn-BD"
	LanguageCodeBnIn LanguageCode = "bn-IN"
	LanguageCodeCaEs LanguageCode = "ca-ES"
	LanguageCodeCsCz LanguageCode = "cs-CZ"
	LanguageCodeDaDk LanguageCode = "da-DK"
	LanguageCodeDeAt LanguageCode = "de-AT"
	LanguageCodeDeCh LanguageCode = "de-CH"
	LanguageCodeDeDe LanguageCode = "de-DE"
	LanguageCodeElGr LanguageCode = "el-GR"
	LanguageCodeEnAu LanguageCode = "en-AU"
	LanguageCodeEnCa LanguageCode = "en-CA"
	LanguageCodeEnGb LanguageCode = "en-GB"
	LanguageCodeEnIe LanguageCode = "en-IE"
	LanguageCodeEnIn LanguageCode = "en-IN"
	LanguageCodeEnNz LanguageCode = "en-NZ"
	LanguageCodeEnUs LanguageCode = "en-US"
	LanguageCodeEnZa LanguageCode = "en-ZA"
	LanguageCodeEsAr LanguageCode = "es-AR"
	LanguageCodeEsCl LanguageCode = "es-CL"
	LanguageCodeEsCo LanguageCode = "es-CO"
	LanguageCodeEsEs LanguageCode = "es-ES"
	LanguageCodeEsMx LanguageCode = "es-MX"
	LanguageCodeEsUs LanguageCode = "es-US"
	LanguageCodeFiFi LanguageCode = "fi-FI"
	LanguageCodeFrBe LanguageCode = "fr-BE"
	LanguageCodeFrCa LanguageCode = "fr-CA"
	LanguageCodeFrCh LanguageCode = "fr-CH"
	LanguageCodeFrFr LanguageCode = "fr-FR"
	LanguageCodeHeIl LanguageCode = "he-IL"
	LanguageCodeHiIn LanguageCode = "hi-IN"
	LanguageCodeHrHr LanguageCode = "hr-HR"
	LanguageCodeHuHu LanguageCode = "hu-HU"
	LanguageCodeIDID LanguageCode = "id-ID"
	LanguageCodeItCh LanguageCode = "it-CH"
	LanguageCodeItIt LanguageCode = "it-IT"
	LanguageCodeJaJp LanguageCode = "ja-JP"
	LanguageCodeKoKr LanguageCode = "ko-KR"
	LanguageCodeMsMy LanguageCode = "ms-MY"
	LanguageCodeNbNo LanguageCode = "nb-NO"
	LanguageCodeNlBe LanguageCode = "nl-BE"
	LanguageCodeNlNl LanguageCode = "nl-NL"
	LanguageCodeNoNo LanguageCode = "no-NO"
	LanguageCodePlPl LanguageCode = "pl-PL"
	LanguageCodePtBr LanguageCode = "pt-BR"
	LanguageCodePtPt LanguageCode = "pt-PT"
	LanguageCodeRoRo LanguageCode = "ro-RO"
	LanguageCodeRuRu LanguageCode = "ru-RU"
	LanguageCodeSkSk LanguageCode = "sk-SK"
	LanguageCodeSvSe LanguageCode = "sv-SE"
	LanguageCodeTaIn LanguageCode = "ta-IN"
	LanguageCodeTaLk LanguageCode = "ta-LK"
	LanguageCodeTeIn LanguageCode = "te-IN"
	LanguageCodeThTh LanguageCode = "th-TH"
	LanguageCodeTrTr LanguageCode = "tr-TR"
	LanguageCodeUkUa LanguageCode = "uk-UA"
	LanguageCodeViVn LanguageCode = "vi-VN"
	LanguageCodeBgBg LanguageCode = "bg-BG"
	LanguageCodeZhCn LanguageCode = "zh-CN"
	LanguageCodeZhHk LanguageCode = "zh-HK"
	LanguageCodeZhTw LanguageCode = "zh-TW"
)

func (LanguageCode) ToPointer added in v1.0.0

func (e LanguageCode) ToPointer() *LanguageCode

func (*LanguageCode) UnmarshalJSON added in v1.0.0

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

type LiveNotFoundErrorError added in v1.0.0

type LiveNotFoundErrorError 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"`
}

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

func (*LiveNotFoundErrorError) GetCode added in v1.0.0

func (l *LiveNotFoundErrorError) GetCode() *float64

func (*LiveNotFoundErrorError) GetDescription added in v1.0.0

func (l *LiveNotFoundErrorError) GetDescription() *string

func (*LiveNotFoundErrorError) GetMessage added in v1.0.0

func (l *LiveNotFoundErrorError) 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 (l *LiveStreamDeleteResponse) GetSuccess() *bool

type LiveStreamPagination added in v1.0.0

type LiveStreamPagination 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"`
}

LiveStreamPagination - Pagination organizes content into pages for better readability and navigation.

func (*LiveStreamPagination) GetCurrentOffset added in v1.0.0

func (l *LiveStreamPagination) GetCurrentOffset() *int64

func (*LiveStreamPagination) GetOffsetCount added in v1.0.0

func (l *LiveStreamPagination) GetOffsetCount() *int64

func (*LiveStreamPagination) GetTotalRecords added in v1.0.0

func (l *LiveStreamPagination) GetTotalRecords() *int64

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 (l *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 (l *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 map[string]string `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 *MediaSourceResolution `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 (m *Media) GetAspectRatio() *string

func (*Media) GetCreatedAt

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

func (*Media) GetDuration

func (m *Media) GetDuration() *string

func (*Media) GetFrameRate

func (m *Media) GetFrameRate() *string

func (*Media) GetID

func (m *Media) GetID() *string

func (*Media) GetMaxResolution

func (m *Media) GetMaxResolution() *MediaMaxResolution

func (*Media) GetMetadata

func (m *Media) GetMetadata() map[string]string

func (*Media) GetMp4Support

func (m *Media) GetMp4Support() *MediaMp4Support

func (*Media) GetPlaybackIds

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

func (*Media) GetSourceAccess

func (m *Media) GetSourceAccess() *bool

func (*Media) GetSourceResolution

func (m *Media) GetSourceResolution() *MediaSourceResolution

func (*Media) GetStatus

func (m *Media) GetStatus() *string

func (*Media) GetThumbnail

func (m *Media) GetThumbnail() *string

func (*Media) GetTracks

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

func (*Media) GetUpdatedAt

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

func (*Media) GetWorkspaceID

func (m *Media) GetWorkspaceID() *string

func (Media) MarshalJSON

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

func (*Media) UnmarshalJSON

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

type MediaCancelResponse added in v1.0.0

type MediaCancelResponse struct {
	// The unique identifier of the cancelled upload.
	UploadID *string `json:"uploadId,omitempty"`
	// Indicates if the upload was a trial.
	Trial *bool `json:"trial,omitempty"`
	// The status of the upload after cancellation.
	Status *string `json:"status,omitempty"`
	// The upload URL (if available) after cancellation.
	URL *string `json:"url,omitempty"`
	// The timeout value for the upload.
	Timeout *int64 `json:"timeout,omitempty"`
	// CORS origin allowed for the upload.
	CorsOrigin *string `json:"corsOrigin,omitempty"`
	// The maximum resolution allowed for the upload.
	MaxResolution *string `json:"maxResolution,omitempty"`
	// The access policy for the upload.
	AccessPolicy *string `json:"accessPolicy,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 map[string]string `json:"metadata,omitempty"`
}

MediaCancelResponse - Response returned when an upload is cancelled.

func (*MediaCancelResponse) GetAccessPolicy added in v1.0.0

func (m *MediaCancelResponse) GetAccessPolicy() *string

func (*MediaCancelResponse) GetCorsOrigin added in v1.0.0

func (m *MediaCancelResponse) GetCorsOrigin() *string

func (*MediaCancelResponse) GetMaxResolution added in v1.0.0

func (m *MediaCancelResponse) GetMaxResolution() *string

func (*MediaCancelResponse) GetMetadata added in v1.0.0

func (m *MediaCancelResponse) GetMetadata() map[string]string

func (*MediaCancelResponse) GetStatus added in v1.0.0

func (m *MediaCancelResponse) GetStatus() *string

func (*MediaCancelResponse) GetTimeout added in v1.0.0

func (m *MediaCancelResponse) GetTimeout() *int64

func (*MediaCancelResponse) GetTrial added in v1.0.0

func (m *MediaCancelResponse) GetTrial() *bool

func (*MediaCancelResponse) GetURL added in v1.0.0

func (m *MediaCancelResponse) GetURL() *string

func (*MediaCancelResponse) GetUploadID added in v1.0.0

func (m *MediaCancelResponse) GetUploadID() *string

type MediaClipNotFoundError added in v1.0.0

type MediaClipNotFoundError 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"`
}

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

func (*MediaClipNotFoundError) GetCode added in v1.0.0

func (m *MediaClipNotFoundError) GetCode() *float64

func (*MediaClipNotFoundError) GetDescription added in v1.0.0

func (m *MediaClipNotFoundError) GetDescription() *string

func (*MediaClipNotFoundError) GetMessage added in v1.0.0

func (m *MediaClipNotFoundError) GetMessage() *string

type MediaClipResponse added in v1.0.0

type MediaClipResponse struct {
	Success    bool                        `json:"success"`
	Data       []MediaClipResponseData     `json:"data"`
	Pagination MediaClipResponsePagination `json:"pagination"`
}

func (*MediaClipResponse) GetData added in v1.0.0

func (*MediaClipResponse) GetPagination added in v1.0.0

func (*MediaClipResponse) GetSuccess added in v1.0.0

func (m *MediaClipResponse) GetSuccess() bool

type MediaClipResponseAccessRestrictions added in v1.0.0

type MediaClipResponseAccessRestrictions struct {
	Domains    *MediaClipResponseDomains    `json:"domains,omitempty"`
	UserAgents *MediaClipResponseUserAgents `json:"userAgents,omitempty"`
}

func (*MediaClipResponseAccessRestrictions) GetDomains added in v1.0.0

func (*MediaClipResponseAccessRestrictions) GetUserAgents added in v1.0.0

type MediaClipResponseData added in v1.0.0

type MediaClipResponseData struct {
	// A video thumbnail that acts as a preview image for the video.
	Thumbnail *string `json:"thumbnail,omitempty"`
	// The unique identifier assigned to the media by FastPix.
	ID *string `json:"id,omitempty"`
	// The ID of the original source media.
	SourceMediaID *string `json:"sourceMediaId,omitempty"`
	// The unique identifier for the workspace associated with the media.
	WorkspaceID *string `json:"workspaceId,omitempty"`
	// Tag a video in "key" : "value" pairs for searchable metadata. Maximum 10 entries, 255 characters each.
	Metadata map[string]string `json:"metadata,omitempty"`
	// The maximum resolution specified for the media.
	MaxResolution *MediaClipResponseMaxResolution `json:"maxResolution,omitempty"`
	// The actual resolution of the uploaded media.
	SourceResolution *MediaClipResponseSourceResolution `json:"sourceResolution,omitempty"`
	// The current processing status of the media.
	Status *Status `json:"status,omitempty"`
	// Indicates whether the original media file is accessible.
	SourceAccess *bool                         `json:"sourceAccess,omitempty"`
	PlaybackIds  []MediaClipResponsePlaybackID `json:"playbackIds,omitempty"`
	Tracks       []MediaClipResponseTrack      `json:"tracks,omitempty"`
	// Generated subtitle tracks associated with the media.
	GeneratedSubtitles []GeneratedSubtitle `json:"generatedSubtitles,omitempty"`
	// Indicates whether the media contains only audio.
	IsAudioOnly *bool `json:"isAudioOnly,omitempty"`
	// Indicates whether subtitles are available for the media.
	SubtitleAvailable *bool `json:"subtitleAvailable,omitempty"`
	// The total duration of the media.
	Duration *string `json:"duration,omitempty"`
	// The aspect ratio of the media.
	AspectRatio *string `json:"aspectRatio,omitempty"`
	// Timestamp of when the media was created.
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	// Timestamp of when the media was last updated.
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
}

func (*MediaClipResponseData) GetAspectRatio added in v1.0.0

func (m *MediaClipResponseData) GetAspectRatio() *string

func (*MediaClipResponseData) GetCreatedAt added in v1.0.0

func (m *MediaClipResponseData) GetCreatedAt() *time.Time

func (*MediaClipResponseData) GetDuration added in v1.0.0

func (m *MediaClipResponseData) GetDuration() *string

func (*MediaClipResponseData) GetGeneratedSubtitles added in v1.0.0

func (m *MediaClipResponseData) GetGeneratedSubtitles() []GeneratedSubtitle

func (*MediaClipResponseData) GetID added in v1.0.0

func (m *MediaClipResponseData) GetID() *string

func (*MediaClipResponseData) GetIsAudioOnly added in v1.0.0

func (m *MediaClipResponseData) GetIsAudioOnly() *bool

func (*MediaClipResponseData) GetMaxResolution added in v1.0.0

func (*MediaClipResponseData) GetMetadata added in v1.0.0

func (m *MediaClipResponseData) GetMetadata() map[string]string

func (*MediaClipResponseData) GetPlaybackIds added in v1.0.0

func (m *MediaClipResponseData) GetPlaybackIds() []MediaClipResponsePlaybackID

func (*MediaClipResponseData) GetSourceAccess added in v1.0.0

func (m *MediaClipResponseData) GetSourceAccess() *bool

func (*MediaClipResponseData) GetSourceMediaID added in v1.0.0

func (m *MediaClipResponseData) GetSourceMediaID() *string

func (*MediaClipResponseData) GetSourceResolution added in v1.0.0

func (m *MediaClipResponseData) GetSourceResolution() *MediaClipResponseSourceResolution

func (*MediaClipResponseData) GetStatus added in v1.0.0

func (m *MediaClipResponseData) GetStatus() *Status

func (*MediaClipResponseData) GetSubtitleAvailable added in v1.0.0

func (m *MediaClipResponseData) GetSubtitleAvailable() *bool

func (*MediaClipResponseData) GetThumbnail added in v1.0.0

func (m *MediaClipResponseData) GetThumbnail() *string

func (*MediaClipResponseData) GetTracks added in v1.0.0

func (*MediaClipResponseData) GetUpdatedAt added in v1.0.0

func (m *MediaClipResponseData) GetUpdatedAt() *time.Time

func (*MediaClipResponseData) GetWorkspaceID added in v1.0.0

func (m *MediaClipResponseData) GetWorkspaceID() *string

func (MediaClipResponseData) MarshalJSON added in v1.0.0

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

func (*MediaClipResponseData) UnmarshalJSON added in v1.0.0

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

type MediaClipResponseDomains added in v1.0.0

type MediaClipResponseDomains struct {
	DefaultPolicy *string  `json:"defaultPolicy,omitempty"`
	Allow         []string `json:"allow,omitempty"`
	Deny          []string `json:"deny,omitempty"`
}

func (*MediaClipResponseDomains) GetAllow added in v1.0.0

func (m *MediaClipResponseDomains) GetAllow() []string

func (*MediaClipResponseDomains) GetDefaultPolicy added in v1.0.0

func (m *MediaClipResponseDomains) GetDefaultPolicy() *string

func (*MediaClipResponseDomains) GetDeny added in v1.0.0

func (m *MediaClipResponseDomains) GetDeny() []string

type MediaClipResponseMaxResolution added in v1.0.0

type MediaClipResponseMaxResolution string

MediaClipResponseMaxResolution - The maximum resolution specified for the media.

const (
	MediaClipResponseMaxResolutionTwoThousandOneHundredAndSixtyp  MediaClipResponseMaxResolution = "2160p"
	MediaClipResponseMaxResolutionOneThousandFourHundredAndFortyp MediaClipResponseMaxResolution = "1440p"
	MediaClipResponseMaxResolutionOneThousandAndEightyp           MediaClipResponseMaxResolution = "1080p"
	MediaClipResponseMaxResolutionSevenHundredAndTwentyp          MediaClipResponseMaxResolution = "720p"
	MediaClipResponseMaxResolutionFourHundredAndEightyp           MediaClipResponseMaxResolution = "480p"
	MediaClipResponseMaxResolutionThreeHundredAndSixtyp           MediaClipResponseMaxResolution = "360p"
)

func (MediaClipResponseMaxResolution) ToPointer added in v1.0.0

func (*MediaClipResponseMaxResolution) UnmarshalJSON added in v1.0.0

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

type MediaClipResponsePagination added in v1.0.0

type MediaClipResponsePagination struct {
	// Total number of records available.
	TotalRecords *int64 `json:"totalRecords,omitempty"`
	// The starting offset of the current result set.
	CurrentOffset *int64 `json:"currentOffset,omitempty"`
	// The number of items returned in the current response.
	OffsetCount *int64 `json:"offsetCount,omitempty"`
}

func (*MediaClipResponsePagination) GetCurrentOffset added in v1.0.0

func (m *MediaClipResponsePagination) GetCurrentOffset() *int64

func (*MediaClipResponsePagination) GetOffsetCount added in v1.0.0

func (m *MediaClipResponsePagination) GetOffsetCount() *int64

func (*MediaClipResponsePagination) GetTotalRecords added in v1.0.0

func (m *MediaClipResponsePagination) GetTotalRecords() *int64

type MediaClipResponsePlaybackID added in v1.0.0

type MediaClipResponsePlaybackID struct {
	// The unique identifier for playback.
	ID *string `json:"id,omitempty"`
	// The access policy of the playback.
	AccessPolicy       *string                              `json:"accessPolicy,omitempty"`
	AccessRestrictions *MediaClipResponseAccessRestrictions `json:"accessRestrictions,omitempty"`
}

func (*MediaClipResponsePlaybackID) GetAccessPolicy added in v1.0.0

func (m *MediaClipResponsePlaybackID) GetAccessPolicy() *string

func (*MediaClipResponsePlaybackID) GetAccessRestrictions added in v1.0.0

func (*MediaClipResponsePlaybackID) GetID added in v1.0.0

func (m *MediaClipResponsePlaybackID) GetID() *string

type MediaClipResponseSourceResolution added in v1.0.0

type MediaClipResponseSourceResolution string

MediaClipResponseSourceResolution - The actual resolution of the uploaded media.

const (
	MediaClipResponseSourceResolutionTwoThousandOneHundredAndSixtyp  MediaClipResponseSourceResolution = "2160p"
	MediaClipResponseSourceResolutionOneThousandFourHundredAndFortyp MediaClipResponseSourceResolution = "1440p"
	MediaClipResponseSourceResolutionOneThousandAndEightyp           MediaClipResponseSourceResolution = "1080p"
	MediaClipResponseSourceResolutionSevenHundredAndTwentyp          MediaClipResponseSourceResolution = "720p"
	MediaClipResponseSourceResolutionFourHundredAndEightyp           MediaClipResponseSourceResolution = "480p"
	MediaClipResponseSourceResolutionThreeHundredAndSixtyp           MediaClipResponseSourceResolution = "360p"
)

func (MediaClipResponseSourceResolution) ToPointer added in v1.0.0

func (*MediaClipResponseSourceResolution) UnmarshalJSON added in v1.0.0

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

type MediaClipResponseTrack added in v1.0.0

type MediaClipResponseTrack struct {
	// The unique identifier for the media track.
	ID *string `json:"id,omitempty"`
	// The type of media track.
	Type *MediaClipResponseType `json:"type,omitempty"`
	// The width of the video track (applicable to video only).
	Width *int64 `json:"width,omitempty"`
	// The height of the video track (applicable to video only).
	Height *int64 `json:"height,omitempty"`
	// The current processing status of the track.
	Status *string `json:"status,omitempty"`
	// The language code of the audio or subtitle track.
	LanguageCode *string `json:"languageCode,omitempty"`
	// The language name of the audio or subtitle track.
	LanguageName *string `json:"languageName,omitempty"`
}

func (*MediaClipResponseTrack) GetHeight added in v1.0.0

func (m *MediaClipResponseTrack) GetHeight() *int64

func (*MediaClipResponseTrack) GetID added in v1.0.0

func (m *MediaClipResponseTrack) GetID() *string

func (*MediaClipResponseTrack) GetLanguageCode added in v1.0.0

func (m *MediaClipResponseTrack) GetLanguageCode() *string

func (*MediaClipResponseTrack) GetLanguageName added in v1.0.0

func (m *MediaClipResponseTrack) GetLanguageName() *string

func (*MediaClipResponseTrack) GetStatus added in v1.0.0

func (m *MediaClipResponseTrack) GetStatus() *string

func (*MediaClipResponseTrack) GetType added in v1.0.0

func (*MediaClipResponseTrack) GetWidth added in v1.0.0

func (m *MediaClipResponseTrack) GetWidth() *int64

type MediaClipResponseType added in v1.0.0

type MediaClipResponseType string

MediaClipResponseType - The type of media track.

const (
	MediaClipResponseTypeVideo    MediaClipResponseType = "video"
	MediaClipResponseTypeAudio    MediaClipResponseType = "audio"
	MediaClipResponseTypeSubtitle MediaClipResponseType = "subtitle"
)

func (MediaClipResponseType) ToPointer added in v1.0.0

func (*MediaClipResponseType) UnmarshalJSON added in v1.0.0

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

type MediaClipResponseUserAgents added in v1.0.0

type MediaClipResponseUserAgents struct {
	DefaultPolicy *string  `json:"defaultPolicy,omitempty"`
	Allow         []string `json:"allow,omitempty"`
	Deny          []string `json:"deny,omitempty"`
}

func (*MediaClipResponseUserAgents) GetAllow added in v1.0.0

func (m *MediaClipResponseUserAgents) GetAllow() []string

func (*MediaClipResponseUserAgents) GetDefaultPolicy added in v1.0.0

func (m *MediaClipResponseUserAgents) GetDefaultPolicy() *string

func (*MediaClipResponseUserAgents) GetDeny added in v1.0.0

func (m *MediaClipResponseUserAgents) GetDeny() []string

type MediaIdsRequest added in v1.0.0

type MediaIdsRequest struct {
	MediaIds []string `json:"mediaIds"`
}

MediaIdsRequest - The list of mediaId(s) you want to perform the operation on.rds by limit.

func (*MediaIdsRequest) GetMediaIds added in v1.0.0

func (m *MediaIdsRequest) GetMediaIds() []string

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 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 (m *MediaNotFoundError) GetCode() *float64

func (*MediaNotFoundError) GetDescription

func (m *MediaNotFoundError) GetDescription() *string

func (*MediaNotFoundError) GetMessage

func (m *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 (m *MediaOrPlaybackNotFoundError) GetCode() *float64

func (*MediaOrPlaybackNotFoundError) GetDescription

func (m *MediaOrPlaybackNotFoundError) GetDescription() *string

func (*MediaOrPlaybackNotFoundError) GetMessage

func (m *MediaOrPlaybackNotFoundError) GetMessage() *string

type MediaSourceResolution added in v1.0.0

type MediaSourceResolution string

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

const (
	MediaSourceResolutionTwoThousandOneHundredAndSixtyp  MediaSourceResolution = "2160p"
	MediaSourceResolutionOneThousandFourHundredAndFortyp MediaSourceResolution = "1440p"
	MediaSourceResolutionOneThousandAndEightyp           MediaSourceResolution = "1080p"
	MediaSourceResolutionSevenHundredAndTwentyp          MediaSourceResolution = "720p"
	MediaSourceResolutionFourHundredAndEightyp           MediaSourceResolution = "480p"
	MediaSourceResolutionThreeHundredAndSixtyp           MediaSourceResolution = "360p"
)

func (MediaSourceResolution) ToPointer added in v1.0.0

func (*MediaSourceResolution) UnmarshalJSON added in v1.0.0

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

type MediaType added in v1.0.0

type MediaType string

MediaType - Type of media content

const (
	MediaTypeVideo MediaType = "video"
	MediaTypeAudio MediaType = "audio"
	MediaTypeAv    MediaType = "av"
)

func (MediaType) ToPointer added in v1.0.0

func (e MediaType) ToPointer() *MediaType

func (*MediaType) UnmarshalJSON added in v1.0.0

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

type MetricValue added in v1.0.0

type MetricValue struct {
	Integer *int64   `queryParam:"inline,name=metricValue"`
	Number  *float64 `queryParam:"inline,name=metricValue"`

	Type MetricValueType
}

MetricValue - The value of the specified metric at the given interval.

func CreateMetricValueInteger added in v1.0.0

func CreateMetricValueInteger(integer int64) MetricValue

func CreateMetricValueNumber added in v1.0.0

func CreateMetricValueNumber(number float64) MetricValue

func (MetricValue) MarshalJSON added in v1.0.0

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

func (*MetricValue) UnmarshalJSON added in v1.0.0

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

type MetricValueType added in v1.0.0

type MetricValueType string
const (
	MetricValueTypeInteger MetricValueType = "integer"
	MetricValueTypeNumber  MetricValueType = "number"
)

type MetricsBreakdownDetails added in v1.0.0

type MetricsBreakdownDetails struct {
	// Total count of view sessions for a paricular video content.
	Views optionalnullable.OptionalNullable[int64] `json:"views,omitempty"`
	// The specific metric value calculated based on the applied filters.
	Value *MetricsBreakdownDetailsValue `json:"value"`
	// Total time watched across all views, represented in milliseconds.
	TotalWatchTime optionalnullable.OptionalNullable[int64] `json:"totalWatchTime,omitempty"`
	// Total time spent playing the video, represented in milliseconds.
	TotalPlayingTime optionalnullable.OptionalNullable[int64] `json:"totalPlayingTime,omitempty"`
	// the value of dimension or filter value on which the aggregation is to be applied.
	Field optionalnullable.OptionalNullable[string] `json:"field,omitempty"`
}

func (*MetricsBreakdownDetails) GetField added in v1.0.0

func (*MetricsBreakdownDetails) GetTotalPlayingTime added in v1.0.0

func (*MetricsBreakdownDetails) GetTotalWatchTime added in v1.0.0

func (*MetricsBreakdownDetails) GetValue added in v1.0.0

func (*MetricsBreakdownDetails) GetViews added in v1.0.0

type MetricsBreakdownDetailsValue added in v1.0.0

type MetricsBreakdownDetailsValue struct {
	Integer *int64   `queryParam:"inline,name=value"`
	Number  *float64 `queryParam:"inline,name=value"`

	Type MetricsBreakdownDetailsValueType
}

MetricsBreakdownDetailsValue - The specific metric value calculated based on the applied filters.

func CreateMetricsBreakdownDetailsValueInteger added in v1.0.0

func CreateMetricsBreakdownDetailsValueInteger(integer int64) MetricsBreakdownDetailsValue

func CreateMetricsBreakdownDetailsValueNumber added in v1.0.0

func CreateMetricsBreakdownDetailsValueNumber(number float64) MetricsBreakdownDetailsValue

func (MetricsBreakdownDetailsValue) MarshalJSON added in v1.0.0

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

func (*MetricsBreakdownDetailsValue) UnmarshalJSON added in v1.0.0

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

type MetricsBreakdownDetailsValueType added in v1.0.0

type MetricsBreakdownDetailsValueType string
const (
	MetricsBreakdownDetailsValueTypeInteger MetricsBreakdownDetailsValueType = "integer"
	MetricsBreakdownDetailsValueTypeNumber  MetricsBreakdownDetailsValueType = "number"
)

type MetricsComparisonDetails added in v1.0.0

type MetricsComparisonDetails struct {
	// The specific metric value calculated based on the applied filters.
	Value *int64 `json:"value,omitempty"`
	// value can be score that ranges from 0 to 100
	Type *string `json:"type,omitempty"`
	// value can be score that ranges from 0 to 100
	Name *string `json:"name,omitempty"`
	// The metric field represents the name of the Key Performance Indicator (KPI) being tracked or analyzed. It identifies a specific measurable aspect of the video playback experience, such as buffering time, video start failure rate, or playback quality.
	//
	Metric *string `json:"metric,omitempty"`
	Items  []Item  `json:"items,omitempty"`
}

func (*MetricsComparisonDetails) GetItems added in v1.0.0

func (m *MetricsComparisonDetails) GetItems() []Item

func (*MetricsComparisonDetails) GetMetric added in v1.0.0

func (m *MetricsComparisonDetails) GetMetric() *string

func (*MetricsComparisonDetails) GetName added in v1.0.0

func (m *MetricsComparisonDetails) GetName() *string

func (*MetricsComparisonDetails) GetType added in v1.0.0

func (m *MetricsComparisonDetails) GetType() *string

func (*MetricsComparisonDetails) GetValue added in v1.0.0

func (m *MetricsComparisonDetails) GetValue() *int64

type MetricsOverallDataDetails added in v1.0.0

type MetricsOverallDataDetails struct {
	// metric value calculated based on the applied filters.
	Value optionalnullable.OptionalNullable[MetricsOverallDataDetailsValue] `json:"value,omitempty"`
	// Total time watched across all views, represented in milliseconds.
	TotalWatchTime optionalnullable.OptionalNullable[int64] `json:"totalWatchTime,omitempty"`
	// The count of unique viewers who interacted with the content.
	UniqueViews optionalnullable.OptionalNullable[int64] `json:"uniqueViews,omitempty"`
	// The total number of views recorded.
	TotalViews optionalnullable.OptionalNullable[int64] `json:"totalViews,omitempty"`
	// Total time spent playing the video, represented in milliseconds.
	TotalPlayTime optionalnullable.OptionalNullable[int64] `json:"totalPlayTime,omitempty"`
	// A global metric value that reflects the overall performance of the specified metric across the entire dataset for the given timespan.
	GlobalValue optionalnullable.OptionalNullable[GlobalValue] `json:"globalValue,omitempty"`
}

MetricsOverallDataDetails - Retrieves overall values for a specified metric

func (*MetricsOverallDataDetails) GetGlobalValue added in v1.0.0

func (*MetricsOverallDataDetails) GetTotalPlayTime added in v1.0.0

func (*MetricsOverallDataDetails) GetTotalViews added in v1.0.0

func (*MetricsOverallDataDetails) GetTotalWatchTime added in v1.0.0

func (*MetricsOverallDataDetails) GetUniqueViews added in v1.0.0

func (*MetricsOverallDataDetails) GetValue added in v1.0.0

type MetricsOverallDataDetailsValue added in v1.0.0

type MetricsOverallDataDetailsValue struct {
	Integer *int64   `queryParam:"inline,name=value"`
	Number  *float64 `queryParam:"inline,name=value"`

	Type MetricsOverallDataDetailsValueType
}

MetricsOverallDataDetailsValue - metric value calculated based on the applied filters.

func CreateMetricsOverallDataDetailsValueInteger added in v1.0.0

func CreateMetricsOverallDataDetailsValueInteger(integer int64) MetricsOverallDataDetailsValue

func CreateMetricsOverallDataDetailsValueNumber added in v1.0.0

func CreateMetricsOverallDataDetailsValueNumber(number float64) MetricsOverallDataDetailsValue

func (MetricsOverallDataDetailsValue) MarshalJSON added in v1.0.0

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

func (*MetricsOverallDataDetailsValue) UnmarshalJSON added in v1.0.0

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

type MetricsOverallDataDetailsValueType added in v1.0.0

type MetricsOverallDataDetailsValueType string
const (
	MetricsOverallDataDetailsValueTypeInteger MetricsOverallDataDetailsValueType = "integer"
	MetricsOverallDataDetailsValueTypeNumber  MetricsOverallDataDetailsValueType = "number"
)

type MetricsOverallMetaDataDetails added in v1.0.0

type MetricsOverallMetaDataDetails struct {
	// defines the field or dimension on which the aggregation is to be   applied.
	Aggregation *string `json:"aggregation,omitempty"`
}

MetricsOverallMetaDataDetails - Metadata that has to be paased for metric calculations.

func (*MetricsOverallMetaDataDetails) GetAggregation added in v1.0.0

func (m *MetricsOverallMetaDataDetails) GetAggregation() *string

type MetricsTimeseriesDataDetails added in v1.0.0

type MetricsTimeseriesDataDetails struct {
	// The timestamp for the data point indicating when the metric value was recorded.
	IntervalTime *time.Time `json:"intervalTime,omitempty"`
	// The value of the specified metric at the given interval.
	MetricValue optionalnullable.OptionalNullable[MetricValue] `json:"metricValue,omitempty"`
	// The total number of views recorded during that interval.
	NumberOfViews optionalnullable.OptionalNullable[int64] `json:"numberOfViews,omitempty"`
}

MetricsTimeseriesDataDetails - The metric's value at specific time intervals.

func (*MetricsTimeseriesDataDetails) GetIntervalTime added in v1.0.0

func (m *MetricsTimeseriesDataDetails) GetIntervalTime() *time.Time

func (*MetricsTimeseriesDataDetails) GetMetricValue added in v1.0.0

func (*MetricsTimeseriesDataDetails) GetNumberOfViews added in v1.0.0

func (MetricsTimeseriesDataDetails) MarshalJSON added in v1.0.0

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

func (*MetricsTimeseriesDataDetails) UnmarshalJSON added in v1.0.0

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

type MetricsTimeseriesMetaDataDetails added in v1.0.0

type MetricsTimeseriesMetaDataDetails struct {
	// the unit for aggregating the timeseries data.
	Granularity *string `json:"granularity,omitempty"`
	// defines the field or dimension on which the aggregation is to be   applied.
	Aggregation *string `json:"aggregation,omitempty"`
}

MetricsTimeseriesMetaDataDetails - Retrieves breakdown values for a specified metric and timespan

func (*MetricsTimeseriesMetaDataDetails) GetAggregation added in v1.0.0

func (m *MetricsTimeseriesMetaDataDetails) GetAggregation() *string

func (*MetricsTimeseriesMetaDataDetails) GetGranularity added in v1.0.0

func (m *MetricsTimeseriesMetaDataDetails) GetGranularity() *string

type Moderation

type Moderation struct {
	// Type of media content
	Type MediaType `json:"type"`
}

func (*Moderation) GetType

func (m *Moderation) GetType() MediaType

type ModerationResponse added in v1.0.0

type ModerationResponse struct {
	MediaID             *string `json:"mediaId,omitempty"`
	IsModerationEnabled *bool   `json:"isModerationEnabled,omitempty"`
}

func (*ModerationResponse) GetIsModerationEnabled added in v1.0.0

func (m *ModerationResponse) GetIsModerationEnabled() *bool

func (*ModerationResponse) GetMediaID added in v1.0.0

func (m *ModerationResponse) GetMediaID() *string

type NamedEntitiesResponse added in v1.0.0

type NamedEntitiesResponse struct {
	MediaID                  *string `json:"mediaId,omitempty"`
	IsGeneratedNamedEntities *bool   `json:"isGeneratedNamedEntities,omitempty"`
}

func (*NamedEntitiesResponse) GetIsGeneratedNamedEntities added in v1.0.0

func (n *NamedEntitiesResponse) GetIsGeneratedNamedEntities() *bool

func (*NamedEntitiesResponse) GetMediaID added in v1.0.0

func (n *NamedEntitiesResponse) GetMediaID() *string

type NotFoundErrorError

type NotFoundErrorError struct {
	Code        *int64  `json:"code,omitempty"`
	Message     *string `json:"message,omitempty"`
	Description *string `json:"description,omitempty"`
}

func (*NotFoundErrorError) GetCode

func (n *NotFoundErrorError) GetCode() *int64

func (*NotFoundErrorError) GetDescription

func (n *NotFoundErrorError) GetDescription() *string

func (*NotFoundErrorError) GetMessage

func (n *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 (n *NotFoundErrorPlaybackIDError) GetCode() *float64

func (*NotFoundErrorPlaybackIDError) GetDescription

func (n *NotFoundErrorPlaybackIDError) GetDescription() *string

func (*NotFoundErrorPlaybackIDError) GetMessage

func (n *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 (n *NotFoundErrorSimulcastError) GetCode() *float64

func (*NotFoundErrorSimulcastError) GetDescription

func (n *NotFoundErrorSimulcastError) GetDescription() *string

func (*NotFoundErrorSimulcastError) GetMessage

func (n *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"`
	// Offset 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 (p *Pagination) GetCurrentOffset() *int64

func (*Pagination) GetOffsetCount

func (p *Pagination) GetOffsetCount() *int64

func (*Pagination) GetTotalRecords

func (p *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 map[string]string `json:"metadata,omitempty"`
	// In case the software streaming the live, gets disrupted for any reason and gets disconnected from FastPix, the reconnect window specifies the time span FastPix will wait before ending the stream. Before starting the stream, you can set the reconnect window time which is up to 1800 seconds.
	ReconnectWindow *int64 `default:"60" json:"reconnectWindow"`
}

func (*PatchLiveStreamRequest) GetMetadata

func (p *PatchLiveStreamRequest) GetMetadata() map[string]string

func (*PatchLiveStreamRequest) GetReconnectWindow

func (p *PatchLiveStreamRequest) GetReconnectWindow() *int64

func (PatchLiveStreamRequest) MarshalJSON

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

func (*PatchLiveStreamRequest) UnmarshalJSON

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

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 (p *PatchResponseDTO) GetData() *PatchResponseData

func (*PatchResponseDTO) GetSuccess

func (p *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 RTMPS 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, gets disrupted for any reason and gets disconnected from FastPix, the reconnect window specifies the time span FastPix will wait before ending the stream. Before starting the stream, you can set the reconnect window time 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    map[string]string    `json:"metadata,omitempty"`
	PlaybackIds []PlaybackIDResponse `json:"playbackIds,omitempty"`
	// This object contains the livestream playback response details for SRT Protocol
	SrtPlaybackResponse *SrtPlaybackResponse `json:"srtPlaybackResponse,omitempty"`
}

PatchResponseData - Displays the result of the request.

func (*PatchResponseData) GetCreatedAt

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

func (*PatchResponseData) GetEnableRecording

func (p *PatchResponseData) GetEnableRecording() *bool

func (*PatchResponseData) GetMaxDuration

func (p *PatchResponseData) GetMaxDuration() *int64

func (*PatchResponseData) GetMaxResolution

func (p *PatchResponseData) GetMaxResolution() *string

func (*PatchResponseData) GetMediaPolicy

func (p *PatchResponseData) GetMediaPolicy() *string

func (*PatchResponseData) GetMetadata

func (p *PatchResponseData) GetMetadata() map[string]string

func (*PatchResponseData) GetPlaybackIds added in v1.0.0

func (p *PatchResponseData) GetPlaybackIds() []PlaybackIDResponse

func (*PatchResponseData) GetReconnectWindow

func (p *PatchResponseData) GetReconnectWindow() *int64

func (*PatchResponseData) GetSrtPlaybackResponse

func (p *PatchResponseData) GetSrtPlaybackResponse() *SrtPlaybackResponse

func (*PatchResponseData) GetSrtSecret

func (p *PatchResponseData) GetSrtSecret() *string

func (*PatchResponseData) GetStatus

func (p *PatchResponseData) GetStatus() *string

func (*PatchResponseData) GetStreamID

func (p *PatchResponseData) GetStreamID() *string

func (*PatchResponseData) GetStreamKey

func (p *PatchResponseData) GetStreamKey() *string

func (*PatchResponseData) GetTrial

func (p *PatchResponseData) GetTrial() *bool

func (PatchResponseData) MarshalJSON

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

func (*PatchResponseData) UnmarshalJSON

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

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 (p *Placement) GetXAlign() *XAlign

func (*Placement) GetXMargin

func (p *Placement) GetXMargin() *string

func (*Placement) GetYAlign

func (p *Placement) GetYAlign() *YAlign

func (*Placement) GetYMargin

func (p *Placement) GetYMargin() *string

func (Placement) MarshalJSON added in v1.0.0

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

func (*Placement) UnmarshalJSON added in v1.0.0

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

type PlaybackID

type PlaybackID struct {
	// A unique identifier is generated by FastPix for the playbacks.
	ID *string `json:"id,omitempty"`
	// Access policy for media content
	AccessPolicy *AccessPolicy `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 (p *PlaybackID) GetAccessPolicy() *AccessPolicy

func (*PlaybackID) GetAccessRestrictions

func (p *PlaybackID) GetAccessRestrictions() *PlaybackIDAccessRestrictions

func (*PlaybackID) GetID

func (p *PlaybackID) GetID() *string

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 {
	// Policy action type
	DefaultPolicy *PolicyAction `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 (p *PlaybackIDDomains) GetAllow() []string

func (*PlaybackIDDomains) GetDefaultPolicy

func (p *PlaybackIDDomains) GetDefaultPolicy() *PolicyAction

func (*PlaybackIDDomains) GetDeny

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

type PlaybackIDRequest

type PlaybackIDRequest struct {
	// Basic access policy for media content
	AccessPolicy *BasicAccessPolicy `json:"accessPolicy,omitempty"`
}

func (*PlaybackIDRequest) GetAccessPolicy

func (p *PlaybackIDRequest) GetAccessPolicy() *BasicAccessPolicy

type PlaybackIDResponse

type PlaybackIDResponse 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"`
}

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

func (*PlaybackIDResponse) GetAccessPolicy added in v1.0.0

func (p *PlaybackIDResponse) GetAccessPolicy() *string

func (*PlaybackIDResponse) GetID added in v1.0.0

func (p *PlaybackIDResponse) GetID() *string

type PlaybackIDSuccessResponse added in v1.0.0

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

PlaybackIDSuccessResponse - Displays the result of the request.

func (*PlaybackIDSuccessResponse) GetData added in v1.0.0

func (*PlaybackIDSuccessResponse) GetSuccess added in v1.0.0

func (p *PlaybackIDSuccessResponse) GetSuccess() *bool

type PlaybackIDSuccessResponseData added in v1.0.0

type PlaybackIDSuccessResponseData 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 (*PlaybackIDSuccessResponseData) GetAccessPolicy added in v1.0.0

func (p *PlaybackIDSuccessResponseData) GetAccessPolicy() *string

func (*PlaybackIDSuccessResponseData) GetID added in v1.0.0

type PlaybackIDUserAgents

type PlaybackIDUserAgents struct {
	// Policy action type
	DefaultPolicy *PolicyAction `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 (p *PlaybackIDUserAgents) GetAllow() []string

func (*PlaybackIDUserAgents) GetDefaultPolicy

func (p *PlaybackIDUserAgents) GetDefaultPolicy() *PolicyAction

func (*PlaybackIDUserAgents) GetDeny

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

type PlaybackSettings

type PlaybackSettings struct {
	// Basic access policy for media content
	AccessPolicy *BasicAccessPolicy `json:"accessPolicy,omitempty"`
}

PlaybackSettings - Displays the result of the playback settings.

func (*PlaybackSettings) GetAccessPolicy

func (p *PlaybackSettings) GetAccessPolicy() *BasicAccessPolicy

type PlayerHeight added in v1.0.0

type PlayerHeight struct {
	Str    *string  `queryParam:"inline,name=playerHeight"`
	Number *float64 `queryParam:"inline,name=playerHeight"`

	Type PlayerHeightType
}

PlayerHeight - Player Height refers to the vertical dimension, measured in pixels, of the video player as it appears on the webpage.

func CreatePlayerHeightNumber added in v1.0.0

func CreatePlayerHeightNumber(number float64) PlayerHeight

func CreatePlayerHeightStr added in v1.0.0

func CreatePlayerHeightStr(str string) PlayerHeight

func (PlayerHeight) MarshalJSON added in v1.0.0

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

func (*PlayerHeight) UnmarshalJSON added in v1.0.0

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

type PlayerHeightType added in v1.0.0

type PlayerHeightType string
const (
	PlayerHeightTypeStr    PlayerHeightType = "str"
	PlayerHeightTypeNumber PlayerHeightType = "number"
)

type PlayerWidth added in v1.0.0

type PlayerWidth struct {
	Str    *string  `queryParam:"inline,name=playerWidth"`
	Number *float64 `queryParam:"inline,name=playerWidth"`

	Type PlayerWidthType
}

PlayerWidth - Player Width refers to the width of the player displayed within the webpage, measured in pixels.

func CreatePlayerWidthNumber added in v1.0.0

func CreatePlayerWidthNumber(number float64) PlayerWidth

func CreatePlayerWidthStr added in v1.0.0

func CreatePlayerWidthStr(str string) PlayerWidth

func (PlayerWidth) MarshalJSON added in v1.0.0

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

func (*PlayerWidth) UnmarshalJSON added in v1.0.0

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

type PlayerWidthType added in v1.0.0

type PlayerWidthType string
const (
	PlayerWidthTypeStr    PlayerWidthType = "str"
	PlayerWidthTypeNumber PlayerWidthType = "number"
)

type PlaylistByIDResponse added in v1.0.0

type PlaylistByIDResponse struct {
	Success *bool                     `json:"success,omitempty"`
	Data    *PlaylistByIDResponseData `json:"data,omitempty"`
}

func (*PlaylistByIDResponse) GetData added in v1.0.0

func (*PlaylistByIDResponse) GetSuccess added in v1.0.0

func (p *PlaylistByIDResponse) GetSuccess() *bool

type PlaylistByIDResponseData added in v1.0.0

type PlaylistByIDResponseData struct {
	// The unique id of the playlist
	ID *string `json:"id,omitempty"`
	// The name of the playlist set by the user
	Name *string `json:"name,omitempty"`
	// Unique string value assigned by user to the playlist.
	ReferenceID *string `json:"referenceId,omitempty"`
	// type of the playlist, when it was created
	Type *PlaylistByIDResponseType `json:"type,omitempty"`
	// Description of the playlist set by the user.
	Description *string                         `json:"description,omitempty"`
	MediaList   []PlaylistByIDResponseMediaList `json:"mediaList,omitempty"`
	// The unique id of the workspace in which the playlist is present.
	WorkspaceID *string `json:"workspaceId,omitempty"`
	// Timestamp of playlist creation.
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	// Playlist's most recent update timestamp.
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	// No. of media present in the playlist
	MediaCount *int64 `json:"mediaCount,omitempty"`
}

func (*PlaylistByIDResponseData) GetCreatedAt added in v1.0.0

func (p *PlaylistByIDResponseData) GetCreatedAt() *time.Time

func (*PlaylistByIDResponseData) GetDescription added in v1.0.0

func (p *PlaylistByIDResponseData) GetDescription() *string

func (*PlaylistByIDResponseData) GetID added in v1.0.0

func (p *PlaylistByIDResponseData) GetID() *string

func (*PlaylistByIDResponseData) GetMediaCount added in v1.0.0

func (p *PlaylistByIDResponseData) GetMediaCount() *int64

func (*PlaylistByIDResponseData) GetMediaList added in v1.0.0

func (*PlaylistByIDResponseData) GetName added in v1.0.0

func (p *PlaylistByIDResponseData) GetName() *string

func (*PlaylistByIDResponseData) GetReferenceID added in v1.0.0

func (p *PlaylistByIDResponseData) GetReferenceID() *string

func (*PlaylistByIDResponseData) GetType added in v1.0.0

func (*PlaylistByIDResponseData) GetUpdatedAt added in v1.0.0

func (p *PlaylistByIDResponseData) GetUpdatedAt() *time.Time

func (*PlaylistByIDResponseData) GetWorkspaceID added in v1.0.0

func (p *PlaylistByIDResponseData) GetWorkspaceID() *string

func (PlaylistByIDResponseData) MarshalJSON added in v1.0.0

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

func (*PlaylistByIDResponseData) UnmarshalJSON added in v1.0.0

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

type PlaylistByIDResponseMediaList added in v1.0.0

type PlaylistByIDResponseMediaList struct {
	// Timestamp of media creation in the workspace.
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	// Duration of the media in hh:mm:ss format.
	Duration *string `json:"duration,omitempty"`
	// unique id of the particular media.
	ID *string `json:"id,omitempty"`
	// source resolution of the media.
	SourceResolution *string `json:"sourceResolution,omitempty"`
	// status of the media, only media with ready status will be added to playlist.
	Status *string `json:"status,omitempty"`
	// thumbnail for the particular media.
	Thumbnail *string `json:"thumbnail,omitempty"`
}

func (*PlaylistByIDResponseMediaList) GetCreatedAt added in v1.0.0

func (p *PlaylistByIDResponseMediaList) GetCreatedAt() *time.Time

func (*PlaylistByIDResponseMediaList) GetDuration added in v1.0.0

func (p *PlaylistByIDResponseMediaList) GetDuration() *string

func (*PlaylistByIDResponseMediaList) GetID added in v1.0.0

func (*PlaylistByIDResponseMediaList) GetSourceResolution added in v1.0.0

func (p *PlaylistByIDResponseMediaList) GetSourceResolution() *string

func (*PlaylistByIDResponseMediaList) GetStatus added in v1.0.0

func (p *PlaylistByIDResponseMediaList) GetStatus() *string

func (*PlaylistByIDResponseMediaList) GetThumbnail added in v1.0.0

func (p *PlaylistByIDResponseMediaList) GetThumbnail() *string

func (PlaylistByIDResponseMediaList) MarshalJSON added in v1.0.0

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

func (*PlaylistByIDResponseMediaList) UnmarshalJSON added in v1.0.0

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

type PlaylistByIDResponseType added in v1.0.0

type PlaylistByIDResponseType string

PlaylistByIDResponseType - type of the playlist, when it was created

const (
	PlaylistByIDResponseTypeManual PlaylistByIDResponseType = "manual"
	PlaylistByIDResponseTypeSmart  PlaylistByIDResponseType = "smart"
)

func (PlaylistByIDResponseType) ToPointer added in v1.0.0

func (*PlaylistByIDResponseType) UnmarshalJSON added in v1.0.0

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

type PlaylistCreatedResponse added in v1.0.0

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

PlaylistCreatedResponse - Displays the result of the request.

func (*PlaylistCreatedResponse) GetData added in v1.0.0

func (*PlaylistCreatedResponse) GetSuccess added in v1.0.0

func (p *PlaylistCreatedResponse) GetSuccess() *bool

type PlaylistCreatedSchema added in v1.0.0

type PlaylistCreatedSchema struct {
	// Upon creating a new play,ist, FastPix assigns a unique identifier to the playlist.
	ID *string `json:"id,omitempty"`
	// The name to the playlist set by the user.
	Name *string `json:"name,omitempty"`
	// Unique string value assigned by user to the playlist.
	ReferenceID *string `json:"referenceId,omitempty"`
	// Type will be either smart or manual, as sent in the request body.
	Type *PlaylistCreatedSchemaType `json:"type,omitempty"`
	// The description to the playlist set by the user.
	Description *string `json:"description,omitempty"`
	// Determines the insertion order of media into playlist.
	PlayOrder *PlaylistOrder `json:"playOrder,omitempty"`
	// date range filter used when creating the smart playlist
	Metadata  *PlaylistCreatedSchemaMetadata   `json:"metadata,omitempty"`
	MediaList []PlaylistCreatedSchemaMediaList `json:"mediaList,omitempty"`
	// Id of the workspace
	WorkspaceID *string `json:"workspaceId,omitempty"`
	// Timestamp of playlist creation.
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	// Playlist's most recent update timestamp.
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	// No. of media present in the playlist
	MediaCount *int64 `json:"mediaCount,omitempty"`
}

PlaylistCreatedSchema - Displays the result of the request.

func (*PlaylistCreatedSchema) GetCreatedAt added in v1.0.0

func (p *PlaylistCreatedSchema) GetCreatedAt() *time.Time

func (*PlaylistCreatedSchema) GetDescription added in v1.0.0

func (p *PlaylistCreatedSchema) GetDescription() *string

func (*PlaylistCreatedSchema) GetID added in v1.0.0

func (p *PlaylistCreatedSchema) GetID() *string

func (*PlaylistCreatedSchema) GetMediaCount added in v1.0.0

func (p *PlaylistCreatedSchema) GetMediaCount() *int64

func (*PlaylistCreatedSchema) GetMediaList added in v1.0.0

func (*PlaylistCreatedSchema) GetMetadata added in v1.0.0

func (*PlaylistCreatedSchema) GetName added in v1.0.0

func (p *PlaylistCreatedSchema) GetName() *string

func (*PlaylistCreatedSchema) GetPlayOrder added in v1.0.0

func (p *PlaylistCreatedSchema) GetPlayOrder() *PlaylistOrder

func (*PlaylistCreatedSchema) GetReferenceID added in v1.0.0

func (p *PlaylistCreatedSchema) GetReferenceID() *string

func (*PlaylistCreatedSchema) GetType added in v1.0.0

func (*PlaylistCreatedSchema) GetUpdatedAt added in v1.0.0

func (p *PlaylistCreatedSchema) GetUpdatedAt() *time.Time

func (*PlaylistCreatedSchema) GetWorkspaceID added in v1.0.0

func (p *PlaylistCreatedSchema) GetWorkspaceID() *string

func (PlaylistCreatedSchema) MarshalJSON added in v1.0.0

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

func (*PlaylistCreatedSchema) UnmarshalJSON added in v1.0.0

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

type PlaylistCreatedSchemaMediaList added in v1.0.0

type PlaylistCreatedSchemaMediaList struct {
	// timestamp of media creation in the workspace
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	// duration of the media in hh:mm:ss format
	Duration *string `json:"duration,omitempty"`
	// unique identifier of the media
	ID *string `json:"id,omitempty"`
	// The source resolution of the media
	SourceResolution *string `json:"sourceResolution,omitempty"`
	// The status of the video in the workspace. Only media which are in ready status are added into the playlist
	Status *string `json:"status,omitempty"`
	// Thumbnail to the particular media
	Thumbnail *string `json:"thumbnail,omitempty"`
}

func (*PlaylistCreatedSchemaMediaList) GetCreatedAt added in v1.0.0

func (p *PlaylistCreatedSchemaMediaList) GetCreatedAt() *time.Time

func (*PlaylistCreatedSchemaMediaList) GetDuration added in v1.0.0

func (p *PlaylistCreatedSchemaMediaList) GetDuration() *string

func (*PlaylistCreatedSchemaMediaList) GetID added in v1.0.0

func (*PlaylistCreatedSchemaMediaList) GetSourceResolution added in v1.0.0

func (p *PlaylistCreatedSchemaMediaList) GetSourceResolution() *string

func (*PlaylistCreatedSchemaMediaList) GetStatus added in v1.0.0

func (p *PlaylistCreatedSchemaMediaList) GetStatus() *string

func (*PlaylistCreatedSchemaMediaList) GetThumbnail added in v1.0.0

func (p *PlaylistCreatedSchemaMediaList) GetThumbnail() *string

func (PlaylistCreatedSchemaMediaList) MarshalJSON added in v1.0.0

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

func (*PlaylistCreatedSchemaMediaList) UnmarshalJSON added in v1.0.0

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

type PlaylistCreatedSchemaMetadata added in v1.0.0

type PlaylistCreatedSchemaMetadata struct {
	// Date range with start and end dates.
	CreatedDate *DateRange `json:"createdDate,omitempty"`
	// Date range with start and end dates.
	UpdatedDate *DateRange `json:"updatedDate,omitempty"`
}

PlaylistCreatedSchemaMetadata - date range filter used when creating the smart playlist

func (*PlaylistCreatedSchemaMetadata) GetCreatedDate added in v1.0.0

func (p *PlaylistCreatedSchemaMetadata) GetCreatedDate() *DateRange

func (*PlaylistCreatedSchemaMetadata) GetUpdatedDate added in v1.0.0

func (p *PlaylistCreatedSchemaMetadata) GetUpdatedDate() *DateRange

type PlaylistCreatedSchemaType added in v1.0.0

type PlaylistCreatedSchemaType string

PlaylistCreatedSchemaType - Type will be either smart or manual, as sent in the request body.

const (
	PlaylistCreatedSchemaTypeSmart  PlaylistCreatedSchemaType = "smart"
	PlaylistCreatedSchemaTypeManual PlaylistCreatedSchemaType = "manual"
)

func (PlaylistCreatedSchemaType) ToPointer added in v1.0.0

func (*PlaylistCreatedSchemaType) UnmarshalJSON added in v1.0.0

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

type PlaylistItem added in v1.0.0

type PlaylistItem struct {
	ID          *string           `json:"id,omitempty"`
	Name        *string           `json:"name,omitempty"`
	Type        *PlaylistItemType `json:"type,omitempty"`
	ReferenceID *string           `json:"referenceId,omitempty"`
	CreatedAt   *time.Time        `json:"createdAt,omitempty"`
	MediaCount  *int64            `json:"mediaCount,omitempty"`
}

func (*PlaylistItem) GetCreatedAt added in v1.0.0

func (p *PlaylistItem) GetCreatedAt() *time.Time

func (*PlaylistItem) GetID added in v1.0.0

func (p *PlaylistItem) GetID() *string

func (*PlaylistItem) GetMediaCount added in v1.0.0

func (p *PlaylistItem) GetMediaCount() *int64

func (*PlaylistItem) GetName added in v1.0.0

func (p *PlaylistItem) GetName() *string

func (*PlaylistItem) GetReferenceID added in v1.0.0

func (p *PlaylistItem) GetReferenceID() *string

func (*PlaylistItem) GetType added in v1.0.0

func (p *PlaylistItem) GetType() *PlaylistItemType

func (PlaylistItem) MarshalJSON added in v1.0.0

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

func (*PlaylistItem) UnmarshalJSON added in v1.0.0

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

type PlaylistItemType added in v1.0.0

type PlaylistItemType string
const (
	PlaylistItemTypeManual PlaylistItemType = "manual"
	PlaylistItemTypeSmart  PlaylistItemType = "smart"
)

func (PlaylistItemType) ToPointer added in v1.0.0

func (e PlaylistItemType) ToPointer() *PlaylistItemType

func (*PlaylistItemType) UnmarshalJSON added in v1.0.0

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

type PlaylistOrder added in v1.0.0

type PlaylistOrder string

PlaylistOrder - Determines the insertion order of media into playlist.

const (
	PlaylistOrderCreatedDateAsc  PlaylistOrder = "createdDate ASC"
	PlaylistOrderCreatedDateDesc PlaylistOrder = "createdDate DESC"
)

func (PlaylistOrder) ToPointer added in v1.0.0

func (e PlaylistOrder) ToPointer() *PlaylistOrder

func (*PlaylistOrder) UnmarshalJSON added in v1.0.0

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

type PolicyAction added in v1.0.0

type PolicyAction string

PolicyAction - Policy action type

const (
	PolicyActionAllow PolicyAction = "allow"
	PolicyActionDeny  PolicyAction = "deny"
)

func (PolicyAction) ToPointer added in v1.0.0

func (e PolicyAction) ToPointer() *PolicyAction

func (*PolicyAction) UnmarshalJSON added in v1.0.0

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

type Security

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

func (*Security) GetPassword

func (s *Security) GetPassword() *string

func (*Security) GetUsername

func (s *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 (s *Segment1) GetInsertAt() int64

func (*Segment1) GetURL

func (s *Segment1) GetURL() string

func (Segment1) MarshalJSON added in v1.0.0

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

func (*Segment1) UnmarshalJSON added in v1.0.0

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

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 (s *Segment2) GetInsertAtEnd() bool

func (*Segment2) GetURL

func (s *Segment2) GetURL() string

func (Segment2) MarshalJSON added in v1.0.0

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

func (*Segment2) UnmarshalJSON added in v1.0.0

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

type SegmentUnion

type SegmentUnion struct {
	Segment1 *Segment1 `queryParam:"inline,name=segment"`
	Segment2 *Segment2 `queryParam:"inline,name=segment"`

	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 SigningKeyNotFoundErrorError added in v1.0.0

type SigningKeyNotFoundErrorError 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"`
}

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

func (*SigningKeyNotFoundErrorError) GetCode added in v1.0.0

func (s *SigningKeyNotFoundErrorError) GetCode() *int64

func (*SigningKeyNotFoundErrorError) GetMessage added in v1.0.0

func (s *SigningKeyNotFoundErrorError) GetMessage() *string

type SigningKeyWorkspaceDTO added in v1.0.0

type SigningKeyWorkspaceDTO struct {
	// FastPix generates a unique identifier for each workspace.
	ID *string `json:"id,omitempty"`
	// Designated title for the workspace.
	Name *string `json:"name,omitempty"`
	// Describes the type of a workspace.  Possible value: QA, staging, production, or development.
	WorkspaceType *string `json:"workspaceType,omitempty"`
}

func (*SigningKeyWorkspaceDTO) GetID added in v1.0.0

func (s *SigningKeyWorkspaceDTO) GetID() *string

func (*SigningKeyWorkspaceDTO) GetName added in v1.0.0

func (s *SigningKeyWorkspaceDTO) GetName() *string

func (*SigningKeyWorkspaceDTO) GetWorkspaceType added in v1.0.0

func (s *SigningKeyWorkspaceDTO) GetWorkspaceType() *string

type SimulcastRequest

type SimulcastRequest struct {
	// The RTMPS 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"`
	// 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 map[string]string `json:"metadata,omitempty"`
}

func (*SimulcastRequest) GetMetadata added in v1.0.0

func (s *SimulcastRequest) GetMetadata() map[string]string

func (*SimulcastRequest) GetStreamKey

func (s *SimulcastRequest) GetStreamKey() *string

func (*SimulcastRequest) GetURL

func (s *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 (s *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 RTMPS 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"`
	// 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 map[string]string `json:"metadata,omitempty"`
}

SimulcastResponseData - Displays the result of the request.

func (*SimulcastResponseData) GetIsEnabled

func (s *SimulcastResponseData) GetIsEnabled() *bool

func (*SimulcastResponseData) GetMetadata

func (s *SimulcastResponseData) GetMetadata() map[string]string

func (*SimulcastResponseData) GetSimulcastID

func (s *SimulcastResponseData) GetSimulcastID() *string

func (*SimulcastResponseData) GetStreamKey

func (s *SimulcastResponseData) GetStreamKey() *string

func (*SimulcastResponseData) GetURL

func (s *SimulcastResponseData) GetURL() *string

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 (s *SimulcastUnavailableError) GetCode() *int64

func (*SimulcastUnavailableError) GetDescription

func (s *SimulcastUnavailableError) GetDescription() *string

func (*SimulcastUnavailableError) GetMessage

func (s *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"`
	// 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 map[string]string `json:"metadata,omitempty"`
}

func (*SimulcastUpdateRequest) GetIsEnabled

func (s *SimulcastUpdateRequest) GetIsEnabled() *bool

func (*SimulcastUpdateRequest) GetMetadata

func (s *SimulcastUpdateRequest) GetMetadata() map[string]string

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 (s *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"`
	// 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 map[string]string `json:"metadata,omitempty"`
}

SimulcastUpdateResponseData - Displays the result of the request.

func (*SimulcastUpdateResponseData) GetIsEnabled

func (s *SimulcastUpdateResponseData) GetIsEnabled() *bool

func (*SimulcastUpdateResponseData) GetMetadata

func (s *SimulcastUpdateResponseData) GetMetadata() map[string]string

func (*SimulcastUpdateResponseData) GetSimulcastID

func (s *SimulcastUpdateResponseData) GetSimulcastID() *string

func (*SimulcastUpdateResponseData) GetStreamKey

func (s *SimulcastUpdateResponseData) GetStreamKey() *string

func (*SimulcastUpdateResponseData) GetURL

func (s *SimulcastUpdateResponseData) GetURL() *string

type SimulcastdeleteResponse

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

func (*SimulcastdeleteResponse) GetSuccess

func (s *SimulcastdeleteResponse) GetSuccess() *bool

type SingingKeysPagination added in v1.0.0

type SingingKeysPagination 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"`
}

SingingKeysPagination - Pagination organizes content into pages for better readability and navigation.

func (*SingingKeysPagination) GetCurrentOffset added in v1.0.0

func (s *SingingKeysPagination) GetCurrentOffset() *int64

func (*SingingKeysPagination) GetOffsetCount added in v1.0.0

func (s *SingingKeysPagination) GetOffsetCount() *int64

func (*SingingKeysPagination) GetTotalRecords added in v1.0.0

func (s *SingingKeysPagination) GetTotalRecords() *int64

type SortOrder added in v1.0.0

type SortOrder string

SortOrder - The values in the list can be arranged in two ways: DESC (Descending) or ASC (Ascending).

const (
	SortOrderAsc  SortOrder = "asc"
	SortOrderDesc SortOrder = "desc"
)

func (SortOrder) ToPointer added in v1.0.0

func (e SortOrder) ToPointer() *SortOrder

func (*SortOrder) UnmarshalJSON added in v1.0.0

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

type SrtPlaybackResponse added in v1.0.0

type SrtPlaybackResponse 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"`
}

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

func (*SrtPlaybackResponse) GetSrtPlaybackSecret added in v1.0.0

func (s *SrtPlaybackResponse) GetSrtPlaybackSecret() *string

func (*SrtPlaybackResponse) GetSrtPlaybackStreamID added in v1.0.0

func (s *SrtPlaybackResponse) GetSrtPlaybackStreamID() *string

type Status added in v1.0.0

type Status string

Status - The current processing status of the media.

const (
	StatusPreparing Status = "preparing"
	StatusReady     Status = "ready"
	StatusFailed    Status = "failed"
	StatusCreated   Status = "created"
)

func (Status) ToPointer added in v1.0.0

func (e Status) ToPointer() *Status

func (*Status) UnmarshalJSON added in v1.0.0

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

type StreamAlreadyDisabledErrorError added in v1.0.0

type StreamAlreadyDisabledErrorError struct {
	// HTTP status code indicating the nature of the error.
	Code *float64 `json:"code,omitempty"`
	// A short message summarizing the error.
	Message *string `json:"message,omitempty"`
	// A detailed explanation indicating that the stream is already in a disabled state and cannot be disabled again.
	//
	Description *string `json:"description,omitempty"`
}

StreamAlreadyDisabledErrorError - Contains details explaining why the request failed.

func (*StreamAlreadyDisabledErrorError) GetCode added in v1.0.0

func (*StreamAlreadyDisabledErrorError) GetDescription added in v1.0.0

func (s *StreamAlreadyDisabledErrorError) GetDescription() *string

func (*StreamAlreadyDisabledErrorError) GetMessage added in v1.0.0

func (s *StreamAlreadyDisabledErrorError) GetMessage() *string

type StreamAlreadyEnabledErrorError added in v1.0.0

type StreamAlreadyEnabledErrorError struct {
	// HTTP status code indicating the nature of the error.
	Code *float64 `json:"code,omitempty"`
	// A short message summarizing the error.
	Message *string `json:"message,omitempty"`
	// A detailed explanation indicating that the stream is already active, idle, or preparing, and therefore cannot be enabled again.
	//
	Description *string `json:"description,omitempty"`
}

StreamAlreadyEnabledErrorError - Contains details explaining why the request failed.

func (*StreamAlreadyEnabledErrorError) GetCode added in v1.0.0

func (*StreamAlreadyEnabledErrorError) GetDescription added in v1.0.0

func (s *StreamAlreadyEnabledErrorError) GetDescription() *string

func (*StreamAlreadyEnabledErrorError) GetMessage added in v1.0.0

func (s *StreamAlreadyEnabledErrorError) GetMessage() *string

func (StreamAlreadyEnabledErrorError) MarshalJSON added in v1.0.0

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

func (*StreamAlreadyEnabledErrorError) UnmarshalJSON added in v1.0.0

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

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"`
	// Language code for content localization
	LanguageCode LanguageCode `json:"languageCode"`
}

SubtitleInput - Generates subtitle files for audio/video files.

func (*SubtitleInput) GetLanguageCode

func (s *SubtitleInput) GetLanguageCode() LanguageCode

func (*SubtitleInput) GetLanguageName

func (s *SubtitleInput) GetLanguageName() string

func (*SubtitleInput) GetType

func (s *SubtitleInput) GetType() string

func (*SubtitleInput) GetURL

func (s *SubtitleInput) GetURL() string

func (SubtitleInput) MarshalJSON added in v1.0.0

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

func (*SubtitleInput) UnmarshalJSON added in v1.0.0

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

type Subtitles added in v1.0.0

type Subtitles 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 maximum of 255 characters and upto 10 entries are allowed.
	Metadata map[string]string `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"`
}

Subtitles - Generates subtitle files for audio/video files.

func (*Subtitles) GetLanguageCode added in v1.0.0

func (s *Subtitles) GetLanguageCode() *CreateMediaRequestLanguageCode

func (*Subtitles) GetLanguageName added in v1.0.0

func (s *Subtitles) GetLanguageName() *string

func (*Subtitles) GetMetadata added in v1.0.0

func (s *Subtitles) GetMetadata() map[string]string

type SuccessResponse added in v1.0.0

type SuccessResponse struct {
	// Demonstrates whether the request is successful or not.
	Success bool `json:"success"`
	// Array of response data
	Data []SuccessResponseData `json:"data"`
}

func (*SuccessResponse) GetData added in v1.0.0

func (s *SuccessResponse) GetData() []SuccessResponseData

func (*SuccessResponse) GetSuccess added in v1.0.0

func (s *SuccessResponse) GetSuccess() bool

type SuccessResponseData added in v1.0.0

type SuccessResponseData struct {
}

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 (s *Summary) GetGenerate() bool

func (*Summary) GetSummaryLength

func (s *Summary) GetSummaryLength() *int64

func (Summary) MarshalJSON

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

func (*Summary) UnmarshalJSON

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

type SummaryResponse added in v1.0.0

type SummaryResponse struct {
	MediaID            *string `json:"mediaId,omitempty"`
	IsGeneratedSummary *bool   `json:"isGeneratedSummary,omitempty"`
}

func (*SummaryResponse) GetIsGeneratedSummary added in v1.0.0

func (s *SummaryResponse) GetIsGeneratedSummary() *bool

func (*SummaryResponse) GetMediaID added in v1.0.0

func (s *SummaryResponse) GetMediaID() *string

type TopErrorDetails added in v1.0.0

type TopErrorDetails struct {
	// views affected by the specific errors.
	Percentage optionalnullable.OptionalNullable[TopErrorDetailsPercentage] `json:"percentage,omitempty"`
	// percentage of unique viewers affected by the specific error.
	UniqueViewersEffectedPercentage optionalnullable.OptionalNullable[UniqueViewersEffectedPercentage] `json:"uniqueViewersEffectedPercentage,omitempty"`
	// Information about the specific error.
	Notes optionalnullable.OptionalNullable[string] `json:"notes,omitempty"`
	// error message or description.
	Message optionalnullable.OptionalNullable[string] `json:"message,omitempty"`
	// The timestamp of when the error was last observed.
	LastSeen optionalnullable.OptionalNullable[string] `json:"lastSeen,omitempty"`
	// unique identifier for the specific error.
	ID optionalnullable.OptionalNullable[string] `json:"id,omitempty"`
	// description of the specific error.
	Description optionalnullable.OptionalNullable[string] `json:"description,omitempty"`
	// Number of occurrences of the specific error.
	Count optionalnullable.OptionalNullable[int64] `json:"count,omitempty"`
	// Error code associated with the specific error.
	Code optionalnullable.OptionalNullable[string] `json:"code,omitempty"`
}

func (*TopErrorDetails) GetCode added in v1.0.0

func (*TopErrorDetails) GetCount added in v1.0.0

func (*TopErrorDetails) GetDescription added in v1.0.0

func (*TopErrorDetails) GetID added in v1.0.0

func (*TopErrorDetails) GetLastSeen added in v1.0.0

func (*TopErrorDetails) GetMessage added in v1.0.0

func (*TopErrorDetails) GetNotes added in v1.0.0

func (*TopErrorDetails) GetPercentage added in v1.0.0

func (*TopErrorDetails) GetUniqueViewersEffectedPercentage added in v1.0.0

func (t *TopErrorDetails) GetUniqueViewersEffectedPercentage() optionalnullable.OptionalNullable[UniqueViewersEffectedPercentage]

type TopErrorDetailsPercentage added in v1.0.0

type TopErrorDetailsPercentage struct {
	Integer *int64   `queryParam:"inline,name=percentage"`
	Number  *float64 `queryParam:"inline,name=percentage"`

	Type TopErrorDetailsPercentageType
}

TopErrorDetailsPercentage - views affected by the specific errors.

func CreateTopErrorDetailsPercentageInteger added in v1.0.0

func CreateTopErrorDetailsPercentageInteger(integer int64) TopErrorDetailsPercentage

func CreateTopErrorDetailsPercentageNumber added in v1.0.0

func CreateTopErrorDetailsPercentageNumber(number float64) TopErrorDetailsPercentage

func (TopErrorDetailsPercentage) MarshalJSON added in v1.0.0

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

func (*TopErrorDetailsPercentage) UnmarshalJSON added in v1.0.0

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

type TopErrorDetailsPercentageType added in v1.0.0

type TopErrorDetailsPercentageType string
const (
	TopErrorDetailsPercentageTypeInteger TopErrorDetailsPercentageType = "integer"
	TopErrorDetailsPercentageTypeNumber  TopErrorDetailsPercentageType = "number"
)

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 (t *Track) GetClosedCaptions() *bool

func (*Track) GetFrameRate

func (t *Track) GetFrameRate() *string

func (*Track) GetHeight

func (t *Track) GetHeight() *float64

func (*Track) GetID

func (t *Track) GetID() *string

func (*Track) GetType

func (t *Track) GetType() string

func (*Track) GetWidth

func (t *Track) GetWidth() *float64

type TrackDuplicateRequestError added in v1.0.0

type TrackDuplicateRequestError 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"`
}

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

func (*TrackDuplicateRequestError) GetCode added in v1.0.0

func (t *TrackDuplicateRequestError) GetCode() *int64

func (*TrackDuplicateRequestError) GetDescription added in v1.0.0

func (t *TrackDuplicateRequestError) GetDescription() *string

func (*TrackDuplicateRequestError) GetMessage added in v1.0.0

func (t *TrackDuplicateRequestError) GetMessage() *string

type TrackSubtitlesGenerateRequest added in v1.0.0

type TrackSubtitlesGenerateRequest struct {
	// The full name of the language in which subtitles will be generated.
	LanguageName string `json:"languageName"`
	// 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 map[string]string `json:"metadata,omitempty"`
	// Language code for content localization
	LanguageCode LanguageCode `json:"languageCode"`
}

TrackSubtitlesGenerateRequest - Contains details for generating subtitle tracks for a media file.

func (*TrackSubtitlesGenerateRequest) GetLanguageCode added in v1.0.0

func (t *TrackSubtitlesGenerateRequest) GetLanguageCode() LanguageCode

func (*TrackSubtitlesGenerateRequest) GetLanguageName added in v1.0.0

func (t *TrackSubtitlesGenerateRequest) GetLanguageName() string

func (*TrackSubtitlesGenerateRequest) GetMetadata added in v1.0.0

func (t *TrackSubtitlesGenerateRequest) GetMetadata() map[string]string

type TrialPlanRestrictionErrorError added in v1.0.0

type TrialPlanRestrictionErrorError struct {
	// HTTP status code indicating the nature of the error.
	Code *float64 `json:"code,omitempty"`
	// A short message summarizing the error.
	Message *string `json:"message,omitempty"`
	// A detailed explanation of the error indicating that the operation is restricted under the trial plan. This typically occurs when certain features are gated for paid users only.
	//
	Description *string `json:"description,omitempty"`
}

TrialPlanRestrictionErrorError - Contains details explaining why the request failed.

func (*TrialPlanRestrictionErrorError) GetCode added in v1.0.0

func (*TrialPlanRestrictionErrorError) GetDescription added in v1.0.0

func (t *TrialPlanRestrictionErrorError) GetDescription() *string

func (*TrialPlanRestrictionErrorError) GetMessage added in v1.0.0

func (t *TrialPlanRestrictionErrorError) GetMessage() *string

func (TrialPlanRestrictionErrorError) MarshalJSON added in v1.0.0

func (t TrialPlanRestrictionErrorError) MarshalJSON() ([]byte, error)

func (*TrialPlanRestrictionErrorError) UnmarshalJSON added in v1.0.0

func (t *TrialPlanRestrictionErrorError) UnmarshalJSON(data []byte) error

type UnAuthorizedResponseError added in v1.0.0

type UnAuthorizedResponseError struct {
	// UnAuthorized response
	Code *int64 `json:"code,omitempty"`
	// A descriptive message providing more details for the error.
	Message *string `json:"message,omitempty"`
}

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

func (*UnAuthorizedResponseError) GetCode added in v1.0.0

func (u *UnAuthorizedResponseError) GetCode() *int64

func (*UnAuthorizedResponseError) GetMessage added in v1.0.0

func (u *UnAuthorizedResponseError) GetMessage() *string

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 (u *UnauthorizedError) GetCode() *int64

func (*UnauthorizedError) GetDescription

func (u *UnauthorizedError) GetDescription() *string

func (*UnauthorizedError) GetMessage

func (u *UnauthorizedError) GetMessage() *string

type UniqueViewersEffectedPercentage added in v1.0.0

type UniqueViewersEffectedPercentage struct {
	Integer *int64   `queryParam:"inline,name=uniqueViewersEffectedPercentage"`
	Number  *float64 `queryParam:"inline,name=uniqueViewersEffectedPercentage"`

	Type UniqueViewersEffectedPercentageType
}

UniqueViewersEffectedPercentage - percentage of unique viewers affected by the specific error.

func CreateUniqueViewersEffectedPercentageInteger added in v1.0.0

func CreateUniqueViewersEffectedPercentageInteger(integer int64) UniqueViewersEffectedPercentage

func CreateUniqueViewersEffectedPercentageNumber added in v1.0.0

func CreateUniqueViewersEffectedPercentageNumber(number float64) UniqueViewersEffectedPercentage

func (UniqueViewersEffectedPercentage) MarshalJSON added in v1.0.0

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

func (*UniqueViewersEffectedPercentage) UnmarshalJSON added in v1.0.0

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

type UniqueViewersEffectedPercentageType added in v1.0.0

type UniqueViewersEffectedPercentageType string
const (
	UniqueViewersEffectedPercentageTypeInteger UniqueViewersEffectedPercentageType = "integer"
	UniqueViewersEffectedPercentageTypeNumber  UniqueViewersEffectedPercentageType = "number"
)

type UpdatePlaylistRequest added in v1.0.0

type UpdatePlaylistRequest struct {
	// New name to the playlist.
	Name string `json:"name"`
	// Updated description to the playlist.
	Description string `json:"description"`
}

func (*UpdatePlaylistRequest) GetDescription added in v1.0.0

func (u *UpdatePlaylistRequest) GetDescription() string

func (*UpdatePlaylistRequest) GetName added in v1.0.0

func (u *UpdatePlaylistRequest) GetName() string

type UpdateTrackRequest added in v1.0.0

type UpdateTrackRequest struct {
	// The direct URL of the track file. It should point to a valid audio or subtitle file.
	URL *string `json:"url,omitempty"`
	// The BCP 47 language code representing the track's language.
	LanguageCode *string `json:"languageCode,omitempty"`
	// The full name of the language corresponding to the `languageCode`.
	LanguageName *string `json:"languageName,omitempty"`
}

UpdateTrackRequest - Contains details about the track being added to the media file.

func (*UpdateTrackRequest) GetLanguageCode added in v1.0.0

func (u *UpdateTrackRequest) GetLanguageCode() *string

func (*UpdateTrackRequest) GetLanguageName added in v1.0.0

func (u *UpdateTrackRequest) GetLanguageName() *string

func (*UpdateTrackRequest) GetURL added in v1.0.0

func (u *UpdateTrackRequest) GetURL() *string

type UpdateTrackResponse added in v1.0.0

type UpdateTrackResponse struct {
	// The unique identifier of the track.
	ID *string `json:"id,omitempty"`
	// Specifies the type of track (audio or subtitle).
	Type *UpdateTrackResponseType `json:"type,omitempty"`
	// The direct URL of the track file.
	URL *string `json:"url,omitempty"`
	// The BCP 47 language code representing the track's language.
	LanguageCode *string `json:"languageCode,omitempty"`
	// The full name of the language corresponding to the `languageCode`.
	LanguageName *string `json:"languageName,omitempty"`
}

UpdateTrackResponse - Contains details about the track that was added or updated.

func (*UpdateTrackResponse) GetID added in v1.0.0

func (u *UpdateTrackResponse) GetID() *string

func (*UpdateTrackResponse) GetLanguageCode added in v1.0.0

func (u *UpdateTrackResponse) GetLanguageCode() *string

func (*UpdateTrackResponse) GetLanguageName added in v1.0.0

func (u *UpdateTrackResponse) GetLanguageName() *string

func (*UpdateTrackResponse) GetType added in v1.0.0

func (*UpdateTrackResponse) GetURL added in v1.0.0

func (u *UpdateTrackResponse) GetURL() *string

type UpdateTrackResponseType added in v1.0.0

type UpdateTrackResponseType string

UpdateTrackResponseType - Specifies the type of track (audio or subtitle).

const (
	UpdateTrackResponseTypeAudio    UpdateTrackResponseType = "audio"
	UpdateTrackResponseTypeSubtitle UpdateTrackResponseType = "subtitle"
)

func (UpdateTrackResponseType) ToPointer added in v1.0.0

func (*UpdateTrackResponseType) UnmarshalJSON added in v1.0.0

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

type UserAgentRestrictions added in v1.0.0

type UserAgentRestrictions struct {
	// Policy action type
	DefaultPolicy *PolicyAction `json:"defaultPolicy,omitempty"`
	// A list of user agents that are explicitly allowed access
	Allow []string `json:"allow,omitempty"`
	// A list of user agents that are explicitly denied access
	Deny []string `json:"deny,omitempty"`
}

UserAgentRestrictions - Restrictions based on the user agent

func (*UserAgentRestrictions) GetAllow added in v1.0.0

func (u *UserAgentRestrictions) GetAllow() []string

func (*UserAgentRestrictions) GetDefaultPolicy added in v1.0.0

func (u *UserAgentRestrictions) GetDefaultPolicy() *PolicyAction

func (*UserAgentRestrictions) GetDeny added in v1.0.0

func (u *UserAgentRestrictions) GetDeny() []string

type ValidationErrorResponseError

type ValidationErrorResponseError 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"`
	// It is an collection of objects, where each object contains information about a specific field and a corresponding error message.
	Fields []FieldError `json:"fields,omitempty"`
}

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

func (*ValidationErrorResponseError) GetCode

func (v *ValidationErrorResponseError) GetCode() *int64

func (*ValidationErrorResponseError) GetFields

func (v *ValidationErrorResponseError) GetFields() []FieldError

func (*ValidationErrorResponseError) GetMessage

func (v *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 (v *VideoInput) GetEndTime() *float64

func (*VideoInput) GetExpungeSegments

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

func (*VideoInput) GetIntroURL

func (v *VideoInput) GetIntroURL() *string

func (*VideoInput) GetOutroURL

func (v *VideoInput) GetOutroURL() *string

func (*VideoInput) GetSegments

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

func (*VideoInput) GetStartTime

func (v *VideoInput) GetStartTime() *float64

func (*VideoInput) GetType

func (v *VideoInput) GetType() string

func (*VideoInput) GetURL

func (v *VideoInput) GetURL() string

func (VideoInput) MarshalJSON added in v1.0.0

func (v VideoInput) MarshalJSON() ([]byte, error)

func (*VideoInput) UnmarshalJSON added in v1.0.0

func (v *VideoInput) UnmarshalJSON(data []byte) error

type ViewNotFoundError added in v1.0.0

type ViewNotFoundError struct {
	// An 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"`
}

ViewNotFoundError - Returns the problem that has occured

func (*ViewNotFoundError) GetCode added in v1.0.0

func (v *ViewNotFoundError) GetCode() *float64

func (*ViewNotFoundError) GetMessage added in v1.0.0

func (v *ViewNotFoundError) GetMessage() *string

type Views added in v1.0.0

type Views struct {
	// The Name associated with the asnId.
	//
	AsnName optionalnullable.OptionalNullable[string] `json:"asnName,omitempty"`
	// The unique identifier assigned to an Autonomous System (AS) on the Internet. The ASN is used to identify and exchange routing information between different networks.
	//
	AsnID optionalnullable.OptionalNullable[int64] `json:"asnId,omitempty"`
	// The media Id value if the video asset is internal to FastPix.
	//
	MediaID optionalnullable.OptionalNullable[string] `json:"mediaId,omitempty"`
	// Buffer Count represents the number of rebuffering events occurring during the video view.
	//
	BufferCount optionalnullable.OptionalNullable[int64] `json:"bufferCount,omitempty"`
	// Buffer Fill indicates the total time, in milliseconds, that viewers wait for rebuffering per video view.
	//
	BufferFill optionalnullable.OptionalNullable[int64] `json:"bufferFill,omitempty"`
	// Buffer Frequency measures the rate at which rebuffering events occur, expressed as events per millisecond.
	//
	BufferFrequency optionalnullable.OptionalNullable[float64] `json:"BufferFrequency,omitempty"`
	// Content Delivery Network (CDN) refers to the network infrastructure responsible for delivering the video content to the viewer.
	//
	Cdn optionalnullable.OptionalNullable[string] `json:"cdn,omitempty"`
	// City indicates the geographical location of the viewer accessing the video content.
	//
	City optionalnullable.OptionalNullable[string] `json:"city,omitempty"`
	// Continent represents the continent name of the viewer accessing the video content.
	//
	Continent optionalnullable.OptionalNullable[string] `json:"continent,omitempty"`
	// Country Code denotes the two-letter ISO code representing the country of origin for the viewer accessing the video content.
	//
	CountryCode optionalnullable.OptionalNullable[string] `json:"countryCode,omitempty"`
	// Country represents the coded text that represents the country name of viewer accessing the video content.
	//
	Country optionalnullable.OptionalNullable[string] `json:"country,omitempty"`
	// User defined metadata. Only accessible once it is enabled in the organization settings.
	//
	Custom1 optionalnullable.OptionalNullable[string] `json:"custom1,omitempty"`
	// User defined metadata. Only accessible once it is enabled in the organization settings.
	//
	Custom2 optionalnullable.OptionalNullable[string] `json:"custom2,omitempty"`
	// User defined metadata. Only accessible once it is enabled in the organization settings.
	//
	Custom3 optionalnullable.OptionalNullable[string] `json:"custom3,omitempty"`
	// User defined metadata. Only accessible once it is enabled in the organization settings.
	//
	Custom4 optionalnullable.OptionalNullable[string] `json:"custom4,omitempty"`
	// User defined metadata. Only accessible once it is enabled in the organization settings.
	//
	Custom5 optionalnullable.OptionalNullable[string] `json:"custom5,omitempty"`
	// User defined metadata. Only accessible once it is enabled in the organization settings.
	//
	Custom6 optionalnullable.OptionalNullable[string] `json:"custom6,omitempty"`
	// User defined metadata. Only accessible once it is enabled in the organization settings.
	//
	Custom7 optionalnullable.OptionalNullable[string] `json:"custom7,omitempty"`
	// User defined metadata. Only accessible once it is enabled in the organization settings.
	//
	Custom8 optionalnullable.OptionalNullable[string] `json:"custom8,omitempty"`
	// User defined metadata. Only accessible once it is enabled in the organization settings.
	//
	Custom9 optionalnullable.OptionalNullable[string] `json:"custom9,omitempty"`
	// User defined metadata. Only accessible once it is enabled in the organization settings.
	//
	Custom10 optionalnullable.OptionalNullable[string] `json:"custom10,omitempty"`
	// It is a unique identifier associated with a specific workspace within the FastPix platform.
	//
	WorkspaceID *string `json:"workspaceId,omitempty"`
	// Events specifies the order of events journey of the video playback
	//
	Events []Event `json:"events,omitempty"`
	// Exit Before Video Start indicates whether a viewer abandoned the video before it started playing, typically due to long loading times.
	//
	ExitBeforeVideoStart *bool `json:"exitBeforeVideoStart,omitempty"`
	// Experiment Name is used in A/B testing scenarios to categorize video views into different experiments.
	//
	ExperimentName *string `json:"experimentName,omitempty"`
	// Insert Timestamp refers to the time instance when the view is started.
	//
	InsertTimestamp *string `json:"insertTimestamp,omitempty"`
	// Latitude refers to the geographical coordinate representing the north-south position of the viewer's location, truncated to one decimal place.
	//
	Latitude optionalnullable.OptionalNullable[string] `json:"latitude,omitempty"`
	// FastPix Live Stream ID is the unique identifier associated with a live stream video media within the FastPix Video platform.
	//
	FpLiveStreamID optionalnullable.OptionalNullable[string] `json:"fpLiveStreamId,omitempty"`
	// Live Stream Latency measures the average time taken from the point of ingest to the point of display for live stream video views.
	//
	LiveStreamLatency optionalnullable.OptionalNullable[float64] `json:"liveStreamLatency,omitempty"`
	// Longitude denotes the geographical coordinate representing the east-west position of the viewer's location, truncated to one decimal place.
	//
	Longitude optionalnullable.OptionalNullable[string] `json:"longitude,omitempty"`
	// Page Load Time measures the time from when the user initiates loading the page to when all resources are loaded on the page.
	//
	PageLoadTime optionalnullable.OptionalNullable[int64] `json:"pageLoadTime,omitempty"`
	// Page Context provides contextual information about the type of page being accessed.
	//
	PageContext optionalnullable.OptionalNullable[string] `json:"pageContext,omitempty"`
	// View Page URL denotes the URL address of the web page where the video content is being accessed.
	//
	ViewPageURL optionalnullable.OptionalNullable[string] `json:"viewPageUrl,omitempty"`
	// FastPix Playback ID refers to the unique identifier associated with the playback instance of a video, particularly used in FastPix Video platform.
	//
	FpPlaybackID optionalnullable.OptionalNullable[string] `json:"fpPlaybackId,omitempty"`
	// Playback Success Score represents a numerical value indicating the success or quality of the video playback experience.
	//
	PlaybackScore optionalnullable.OptionalNullable[float32] `json:"playbackScore,omitempty"`
	// Player Autoplay On indicates whether the video player automatically initiated playback of the video content.
	//
	PlayerAutoplayOn *bool `json:"playerAutoplayOn,omitempty"`
	// Error Code is an identifier representing a specific type of error that occurred during video playback, potentially leading to playback failure.
	//
	ErrorCode optionalnullable.OptionalNullable[string] `json:"errorCode,omitempty"`
	// Error Message is a descriptive message generated by the video player when an error occurs during playback, associated with an error code.
	//
	ErrorMessage optionalnullable.OptionalNullable[string] `json:"errorMessage,omitempty"`
	// Player Height refers to the vertical dimension, measured in pixels, of the video player as it appears on the webpage.
	//
	PlayerHeight optionalnullable.OptionalNullable[PlayerHeight] `json:"playerHeight,omitempty"`
	// Player Instance ID is a unique identifier that distinguishes each instance of the Player class created when initializing a video.
	//
	PlayerInstanceID optionalnullable.OptionalNullable[string] `json:"playerInstanceId,omitempty"`
	// Player Language indicates the language used for text elements within the video player interface.
	//
	PlayerLanguage optionalnullable.OptionalNullable[string] `json:"playerLanguage,omitempty"`
	// FastPix SDK Name identifies the name of the FastPix Player SDK utilized within the player workspace.
	//
	FpSDK optionalnullable.OptionalNullable[string] `json:"fpSdk,omitempty"`
	// FastPix SDK Version specifies the version of the FastPix Player SDK integrated into the player.
	//
	FpSDKVersion optionalnullable.OptionalNullable[string] `json:"fpSdkVersion,omitempty"`
	// Player Name serves to differentiate various configurations or types of players used across the website or application.
	//
	PlayerName optionalnullable.OptionalNullable[string] `json:"playerName,omitempty"`
	// Player Poster refers to the image displayed as a preview before the video playback begins.
	//
	PlayerPoster optionalnullable.OptionalNullable[string] `json:"playerPoster,omitempty"`
	// Player Preload On indicates whether the player is configured to preload the video content upon page load.
	//
	PlayerPreloadOn *bool `json:"playerPreloadOn,omitempty"`
	// Player Remote Played specifies if the video is being remotely played to devices such as AirPlay or Chromecast, obtained from the SDK.
	//
	PlayerRemotePlayed *bool `json:"playerRemotePlayed,omitempty"`
	// Player Software Version indicates the version number of the player software installed.
	//
	PlayerSoftwareVersion optionalnullable.OptionalNullable[string] `json:"playerSoftwareVersion,omitempty"`
	// Player Software Name denotes the software utilized for video playback within the player workspace.
	//
	PlayerSoftwareName optionalnullable.OptionalNullable[string] `json:"playerSoftwareName,omitempty"`
	// Video Source Domain identifies the domain from which the video source originates.
	//
	VideoSourceDomain optionalnullable.OptionalNullable[string] `json:"videoSourceDomain,omitempty"`
	// Video Source Duration represents the duration of the video source content, measured in milliseconds.
	//
	VideoSourceDuration optionalnullable.OptionalNullable[int64] `json:"videoSourceDuration,omitempty"`
	// Player Source Height denotes the vertical dimension, measured in pixels, of the source video content being transmitted to the player.
	//
	PlayerSourceHeight optionalnullable.OptionalNullable[int64] `json:"playerSourceHeight,omitempty"`
	// Video Source Hostname represents the hostname of the video
	//
	VideoSourceHostname optionalnullable.OptionalNullable[string] `json:"videoSourceHostname,omitempty"`
	// Video Source Stream Type denotes the type of stream used by the player, although it is currently unused.
	//
	VideoSourceStreamType optionalnullable.OptionalNullable[string] `json:"videoSourceStreamType,omitempty"`
	// Video Source Type denotes the format of the video source as determined by the player, including formats
	//
	VideoSourceType optionalnullable.OptionalNullable[string] `json:"videoSourceType,omitempty"`
	// Player Source URL refers to the URL of the video source accessed by the player.
	//
	VideoSourceURL optionalnullable.OptionalNullable[string] `json:"videoSourceUrl,omitempty"`
	// Source Width represents the width of the source video as perceived by the player, typically measured in pixels.
	//
	PlayerSourceWidth optionalnullable.OptionalNullable[int64] `json:"playerSourceWidth,omitempty"`
	// Player Initialisation Time measures the duration, in milliseconds, from the initialization of the player within the webpage to its readiness to receive further instructions.
	//
	PlayerInitializationTime optionalnullable.OptionalNullable[int64] `json:"playerInitializationTime,omitempty"`
	// Player Version indicates the version of the player used to render the video content. It is often utilized for performance comparison between different player versions.
	//
	PlayerVersion optionalnullable.OptionalNullable[string] `json:"playerVersion,omitempty"`
	// Player Width refers to the width of the player displayed within the webpage, measured in pixels.
	//
	PlayerWidth optionalnullable.OptionalNullable[PlayerWidth] `json:"playerWidth,omitempty"`
	// Render Quality Score is a decimal value representing the score indicating the perceived quality of the video.
	//
	RenderQualityScore optionalnullable.OptionalNullable[float32] `json:"renderQualityScore,omitempty"`
	// Buffer Ratio refers to the percentage of time during video playback where the viewer experiences buffering or rebuffering events.
	//
	BufferRatio optionalnullable.OptionalNullable[float32] `json:"bufferRatio,omitempty"`
	// Stability Score quantifies the smoothness of video playback, typically represented as a decimal value.
	//
	StabilityScore optionalnullable.OptionalNullable[float32] `json:"stabilityScore,omitempty"`
	// Region denotes the geographical region of the viewer accessing the video content.
	//
	Region optionalnullable.OptionalNullable[string] `json:"region,omitempty"`
	// Session ID refers to the unique identifier tracking a viewer's session within the FastPix platform.
	//
	SessionID optionalnullable.OptionalNullable[string] `json:"sessionId,omitempty"`
	// Startup Time Score evaluates the startup performance of the player, usually represented as a decimal value
	//
	StartupScore optionalnullable.OptionalNullable[float32] `json:"startupScore,omitempty"`
	// Sub Property ID denotes the unique identifier assigned to FastPix properties, previously linked with a specific workspace.
	//
	SubPropertyID optionalnullable.OptionalNullable[string] `json:"subPropertyId,omitempty"`
	// Video Startup Time measures the duration, in milliseconds, from the initialization of the player within the webpage to its readiness to receive further instructions.
	//
	VideoStartupTime optionalnullable.OptionalNullable[int64] `json:"videoStartupTime,omitempty"`
	// Updated Timestamp refers to when the record is updated to a particular Video.
	//
	UpdatedTimestamp optionalnullable.OptionalNullable[string] `json:"updatedTimestamp,omitempty"`
	// Used Fullscreen denotes whether the viewer utilized the full-screen mode while watching the video.
	//
	UsedFullScreen *bool `json:"usedFullScreen,omitempty"`
	// Video Content Type specifies the classification of the video content.
	//
	VideoContentType optionalnullable.OptionalNullable[string] `json:"videoContentType,omitempty"`
	// Video Duration represents the length of the video, provided in milliseconds, typically supplied to FastPix via custom metadata.
	//
	VideoDuration optionalnullable.OptionalNullable[int64] `json:"videoDuration,omitempty"`
	// Video ID refers to an internal identifier assigned by the user or system to uniquely identify a particular video.
	//
	VideoID optionalnullable.OptionalNullable[string] `json:"videoId,omitempty"`
	// Video Language denotes the primary audio language of the video content, assuming it remains unchanged after playback initiation.
	//
	VideoLanguage optionalnullable.OptionalNullable[string] `json:"videoLanguage,omitempty"`
	// Video Series denotes the name of a series to which the video content belongs.
	//
	VideoSeries optionalnullable.OptionalNullable[string] `json:"videoSeries,omitempty"`
	// Video Startup Failure is a boolean metric indicating whether a viewer encountered an error before the first frame of the video commenced playback.
	//
	VideoStartupFailed *bool `json:"videoStartupFailed,omitempty"`
	// Video Title refers to the title of the video content being viewed.
	//
	VideoTitle optionalnullable.OptionalNullable[string] `json:"videoTitle,omitempty"`
	// Average Request Latency average time it takes for a request to be made and processed during video playback
	//
	AvgRequestLatency optionalnullable.OptionalNullable[float32] `json:"avgRequestLatency,omitempty"`
	// Average Request Throughput refers to the average throughput or data transfer rate of HTTP requests made during video playback
	//
	AvgRequestThroughput optionalnullable.OptionalNullable[float32] `json:"avgRequestThroughput,omitempty"`
	// DRM Type indicates the type of Digital Rights Management (DRM) utilized during video playback
	//
	DrmType optionalnullable.OptionalNullable[string] `json:"drmType,omitempty"`
	// Dropped Frame Count represents the number of frames dropped by the video player during playback.
	//
	DroppedFrameCount optionalnullable.OptionalNullable[int64] `json:"droppedFrameCount,omitempty"`
	// View End refers to the date and time, in Coordinated Universal Time (UTC), when the video viewing session concluded.
	//
	ViewEnd optionalnullable.OptionalNullable[string] `json:"viewEnd,omitempty"`
	// View Has Ad is a boolean metric indicating whether an advertisement played or attempted to play during the video view.
	//
	ViewHasAd *bool `json:"viewHasAd,omitempty"`
	// View ID is a unique identifier assigned to each individual video viewing session.
	//
	ViewID *string `json:"viewId,omitempty"`
	// Maximum Downscale Percentage represents the highest percentage of downscaling applied to the video during the view.
	//
	MaxDownscaling optionalnullable.OptionalNullable[float32] `json:"maxDownscaling,omitempty"`
	// View Max Playhead Position represents the furthest point reached by the playhead during the video view, measured in milliseconds.
	//
	ViewMaxPlayheadPosition optionalnullable.OptionalNullable[int64] `json:"viewMaxPlayheadPosition,omitempty"`
	// Max request Latency refers to the maximum rate of data transfer (throughput) during requests made by the playback.
	//
	MaxRequestLatency optionalnullable.OptionalNullable[float32] `json:"maxRequestLatency,omitempty"`
	// Maximum Upscale Percentage represents the highest percentage of upscaling applied to the video during the view.
	//
	MaxUpscaling optionalnullable.OptionalNullable[float32] `json:"maxUpscaling,omitempty"`
	// Playing Time denotes the total duration of time the video content was actively playing during the view, excluding time spent buffering, seeking, or joining.
	//
	ViewPlayingTime optionalnullable.OptionalNullable[int64] `json:"viewPlayingTime,omitempty"`
	// View Seeked Count signifies the number of times the viewer attempted to seek to a new location within the video.
	//
	ViewSeekedCount optionalnullable.OptionalNullable[int64] `json:"viewSeekedCount,omitempty"`
	// View Seeked Duration indicates the total duration of time spent waiting for playback to resume after the viewer seeks to a new location. Seek Latency metric in the Dashboard is derived by dividing this value by the view_seek_count.
	//
	ViewSeekedDuration optionalnullable.OptionalNullable[int64] `json:"viewSeekedDuration,omitempty"`
	// View Start refers to the date and time, in Coordinated Universal Time (UTC), when the video viewing session commenced.
	//
	ViewStart optionalnullable.OptionalNullable[string] `json:"viewStart,omitempty"`
	// View Total content Playback Time represents the cumulative duration of video content watched by the viewer, measured in milliseconds. This metric is internally utilized to calculate upscale and downscale percentages.
	//
	ViewTotalContentPlaybackTime optionalnullable.OptionalNullable[int64] `json:"viewTotalContentPlaybackTime,omitempty"`
	// Average Downscaling refers to the average reduction in video resolution or quality during the playback of video content.
	//
	AvgDownscaling optionalnullable.OptionalNullable[float32] `json:"avgDownscaling,omitempty"`
	// Average Upscaling refers to the average resolution of the video source is lower than the resolution of the playback device or screen.
	//
	AvgUpscaling optionalnullable.OptionalNullable[float32] `json:"avgUpscaling,omitempty"`
	// Browser denotes the software application utilized by the viewer to access and watch the video content
	//
	BrowserName optionalnullable.OptionalNullable[string] `json:"browserName,omitempty"`
	// Browser version signifies the specific version of the browser software employed by the viewer
	//
	BrowserVersion optionalnullable.OptionalNullable[string] `json:"browserVersion,omitempty"`
	// Connection Type signifies the type of network connection utilized by the viewer's device
	//
	Connectiontype optionalnullable.OptionalNullable[string] `json:"connectiontype,omitempty"`
	// Device Type denotes the classification of the device used by the viewer
	//
	DeviceType optionalnullable.OptionalNullable[string] `json:"deviceType,omitempty"`
	// Device Manufacturer indicates the brand or manufacturer of the device used by the viewer.
	//
	DeviceManufacturer optionalnullable.OptionalNullable[string] `json:"deviceManufacturer,omitempty"`
	// Device Model represents the specific model of the device used by the viewer.
	//
	DeviceModel optionalnullable.OptionalNullable[string] `json:"deviceModel,omitempty"`
	// Device Name refers to the name or label assigned to the device used by the viewer.
	//
	DeviceName optionalnullable.OptionalNullable[string] `json:"deviceName,omitempty"`
	// Quality Of Experience Score quantifies the overall viewer experience based on various metrics, providing a decimal score to assess the quality of the viewing experience.
	//
	QualityOfExperienceScore optionalnullable.OptionalNullable[float32] `json:"qualityOfExperienceScore,omitempty"`
	// Operating System signifies the name of software platform utilized by the viewer.
	//
	OsName optionalnullable.OptionalNullable[string] `json:"osName,omitempty"`
	// Operating System Version specifies the specific version of the operating system being used by the viewer
	//
	OsVersion *string `json:"osVersion,omitempty"`
	// User Agent represents the user agent string transmitted by the viewer's device to identify itself to the server, typically including information about the device and browser.
	//
	UserAgent optionalnullable.OptionalNullable[string] `json:"userAgent,omitempty"`
	// Viewer ID refers to a customer-defined identifier representing the viewer who is watching the video stream. It should be anonymized and not contain any personally identifiable information.
	//
	ViewerID optionalnullable.OptionalNullable[string] `json:"viewerId,omitempty"`
	// Total Watch Time denotes the total duration of video content watched by the viewer, encompassing startup time, playing time, and potential rebuffering time, measured in milliseconds.
	//
	TotalWatchTime optionalnullable.OptionalNullable[int64] `json:"totalWatchTime,omitempty"`
	// Average Bitrate represents the average bitrate of the video content watched by the viewer, expressed in bits per second (bps). This metric provides insight into the quality of the video stream.
	//
	AverageBitrate optionalnullable.OptionalNullable[float32] `json:"averageBitrate,omitempty"`
	// Jump Latency refers to the delay or latency experienced when there is a jump or seek action performed by the viewer while watching a video.
	//
	JumpLatency optionalnullable.OptionalNullable[float32] `json:"jumpLatency,omitempty"`
	// Player Resolution refers to the resolution of the video player window or viewport where the video content is being displayed.
	//
	PlayerResolution optionalnullable.OptionalNullable[string] `json:"playerResolution,omitempty"`
	// videoResolution refers to the resolution of the video being played.
	//
	VideoResolution optionalnullable.OptionalNullable[string] `json:"videoResolution,omitempty"`
}

Views - Displays the result of the request.

func (*Views) GetAsnID added in v1.0.0

func (*Views) GetAsnName added in v1.0.0

func (v *Views) GetAsnName() optionalnullable.OptionalNullable[string]

func (*Views) GetAverageBitrate added in v1.0.0

func (v *Views) GetAverageBitrate() optionalnullable.OptionalNullable[float32]

func (*Views) GetAvgDownscaling added in v1.0.0

func (v *Views) GetAvgDownscaling() optionalnullable.OptionalNullable[float32]

func (*Views) GetAvgRequestLatency added in v1.0.0

func (v *Views) GetAvgRequestLatency() optionalnullable.OptionalNullable[float32]

func (*Views) GetAvgRequestThroughput added in v1.0.0

func (v *Views) GetAvgRequestThroughput() optionalnullable.OptionalNullable[float32]

func (*Views) GetAvgUpscaling added in v1.0.0

func (v *Views) GetAvgUpscaling() optionalnullable.OptionalNullable[float32]

func (*Views) GetBrowserName added in v1.0.0

func (v *Views) GetBrowserName() optionalnullable.OptionalNullable[string]

func (*Views) GetBrowserVersion added in v1.0.0

func (v *Views) GetBrowserVersion() optionalnullable.OptionalNullable[string]

func (*Views) GetBufferCount added in v1.0.0

func (v *Views) GetBufferCount() optionalnullable.OptionalNullable[int64]

func (*Views) GetBufferFill added in v1.0.0

func (v *Views) GetBufferFill() optionalnullable.OptionalNullable[int64]

func (*Views) GetBufferFrequency added in v1.0.0

func (v *Views) GetBufferFrequency() optionalnullable.OptionalNullable[float64]

func (*Views) GetBufferRatio added in v1.0.0

func (v *Views) GetBufferRatio() optionalnullable.OptionalNullable[float32]

func (*Views) GetCdn added in v1.0.0

func (*Views) GetCity added in v1.0.0

func (*Views) GetConnectiontype added in v1.0.0

func (v *Views) GetConnectiontype() optionalnullable.OptionalNullable[string]

func (*Views) GetContinent added in v1.0.0

func (v *Views) GetContinent() optionalnullable.OptionalNullable[string]

func (*Views) GetCountry added in v1.0.0

func (v *Views) GetCountry() optionalnullable.OptionalNullable[string]

func (*Views) GetCountryCode added in v1.0.0

func (v *Views) GetCountryCode() optionalnullable.OptionalNullable[string]

func (*Views) GetCustom1 added in v1.0.0

func (v *Views) GetCustom1() optionalnullable.OptionalNullable[string]

func (*Views) GetCustom10 added in v1.0.0

func (v *Views) GetCustom10() optionalnullable.OptionalNullable[string]

func (*Views) GetCustom2 added in v1.0.0

func (v *Views) GetCustom2() optionalnullable.OptionalNullable[string]

func (*Views) GetCustom3 added in v1.0.0

func (v *Views) GetCustom3() optionalnullable.OptionalNullable[string]

func (*Views) GetCustom4 added in v1.0.0

func (v *Views) GetCustom4() optionalnullable.OptionalNullable[string]

func (*Views) GetCustom5 added in v1.0.0

func (v *Views) GetCustom5() optionalnullable.OptionalNullable[string]

func (*Views) GetCustom6 added in v1.0.0

func (v *Views) GetCustom6() optionalnullable.OptionalNullable[string]

func (*Views) GetCustom7 added in v1.0.0

func (v *Views) GetCustom7() optionalnullable.OptionalNullable[string]

func (*Views) GetCustom8 added in v1.0.0

func (v *Views) GetCustom8() optionalnullable.OptionalNullable[string]

func (*Views) GetCustom9 added in v1.0.0

func (v *Views) GetCustom9() optionalnullable.OptionalNullable[string]

func (*Views) GetDeviceManufacturer added in v1.0.0

func (v *Views) GetDeviceManufacturer() optionalnullable.OptionalNullable[string]

func (*Views) GetDeviceModel added in v1.0.0

func (v *Views) GetDeviceModel() optionalnullable.OptionalNullable[string]

func (*Views) GetDeviceName added in v1.0.0

func (v *Views) GetDeviceName() optionalnullable.OptionalNullable[string]

func (*Views) GetDeviceType added in v1.0.0

func (v *Views) GetDeviceType() optionalnullable.OptionalNullable[string]

func (*Views) GetDrmType added in v1.0.0

func (v *Views) GetDrmType() optionalnullable.OptionalNullable[string]

func (*Views) GetDroppedFrameCount added in v1.0.0

func (v *Views) GetDroppedFrameCount() optionalnullable.OptionalNullable[int64]

func (*Views) GetErrorCode added in v1.0.0

func (v *Views) GetErrorCode() optionalnullable.OptionalNullable[string]

func (*Views) GetErrorMessage added in v1.0.0

func (v *Views) GetErrorMessage() optionalnullable.OptionalNullable[string]

func (*Views) GetEvents added in v1.0.0

func (v *Views) GetEvents() []Event

func (*Views) GetExitBeforeVideoStart added in v1.0.0

func (v *Views) GetExitBeforeVideoStart() *bool

func (*Views) GetExperimentName added in v1.0.0

func (v *Views) GetExperimentName() *string

func (*Views) GetFpLiveStreamID added in v1.0.0

func (v *Views) GetFpLiveStreamID() optionalnullable.OptionalNullable[string]

func (*Views) GetFpPlaybackID added in v1.0.0

func (v *Views) GetFpPlaybackID() optionalnullable.OptionalNullable[string]

func (*Views) GetFpSDK added in v1.0.0

func (*Views) GetFpSDKVersion added in v1.0.0

func (v *Views) GetFpSDKVersion() optionalnullable.OptionalNullable[string]

func (*Views) GetInsertTimestamp added in v1.0.0

func (v *Views) GetInsertTimestamp() *string

func (*Views) GetJumpLatency added in v1.0.0

func (v *Views) GetJumpLatency() optionalnullable.OptionalNullable[float32]

func (*Views) GetLatitude added in v1.0.0

func (v *Views) GetLatitude() optionalnullable.OptionalNullable[string]

func (*Views) GetLiveStreamLatency added in v1.0.0

func (v *Views) GetLiveStreamLatency() optionalnullable.OptionalNullable[float64]

func (*Views) GetLongitude added in v1.0.0

func (v *Views) GetLongitude() optionalnullable.OptionalNullable[string]

func (*Views) GetMaxDownscaling added in v1.0.0

func (v *Views) GetMaxDownscaling() optionalnullable.OptionalNullable[float32]

func (*Views) GetMaxRequestLatency added in v1.0.0

func (v *Views) GetMaxRequestLatency() optionalnullable.OptionalNullable[float32]

func (*Views) GetMaxUpscaling added in v1.0.0

func (v *Views) GetMaxUpscaling() optionalnullable.OptionalNullable[float32]

func (*Views) GetMediaID added in v1.0.0

func (v *Views) GetMediaID() optionalnullable.OptionalNullable[string]

func (*Views) GetOsName added in v1.0.0

func (*Views) GetOsVersion added in v1.0.0

func (v *Views) GetOsVersion() *string

func (*Views) GetPageContext added in v1.0.0

func (v *Views) GetPageContext() optionalnullable.OptionalNullable[string]

func (*Views) GetPageLoadTime added in v1.0.0

func (v *Views) GetPageLoadTime() optionalnullable.OptionalNullable[int64]

func (*Views) GetPlaybackScore added in v1.0.0

func (v *Views) GetPlaybackScore() optionalnullable.OptionalNullable[float32]

func (*Views) GetPlayerAutoplayOn added in v1.0.0

func (v *Views) GetPlayerAutoplayOn() *bool

func (*Views) GetPlayerHeight added in v1.0.0

func (v *Views) GetPlayerHeight() optionalnullable.OptionalNullable[PlayerHeight]

func (*Views) GetPlayerInitializationTime added in v1.0.0

func (v *Views) GetPlayerInitializationTime() optionalnullable.OptionalNullable[int64]

func (*Views) GetPlayerInstanceID added in v1.0.0

func (v *Views) GetPlayerInstanceID() optionalnullable.OptionalNullable[string]

func (*Views) GetPlayerLanguage added in v1.0.0

func (v *Views) GetPlayerLanguage() optionalnullable.OptionalNullable[string]

func (*Views) GetPlayerName added in v1.0.0

func (v *Views) GetPlayerName() optionalnullable.OptionalNullable[string]

func (*Views) GetPlayerPoster added in v1.0.0

func (v *Views) GetPlayerPoster() optionalnullable.OptionalNullable[string]

func (*Views) GetPlayerPreloadOn added in v1.0.0

func (v *Views) GetPlayerPreloadOn() *bool

func (*Views) GetPlayerRemotePlayed added in v1.0.0

func (v *Views) GetPlayerRemotePlayed() *bool

func (*Views) GetPlayerResolution added in v1.0.0

func (v *Views) GetPlayerResolution() optionalnullable.OptionalNullable[string]

func (*Views) GetPlayerSoftwareName added in v1.0.0

func (v *Views) GetPlayerSoftwareName() optionalnullable.OptionalNullable[string]

func (*Views) GetPlayerSoftwareVersion added in v1.0.0

func (v *Views) GetPlayerSoftwareVersion() optionalnullable.OptionalNullable[string]

func (*Views) GetPlayerSourceHeight added in v1.0.0

func (v *Views) GetPlayerSourceHeight() optionalnullable.OptionalNullable[int64]

func (*Views) GetPlayerSourceWidth added in v1.0.0

func (v *Views) GetPlayerSourceWidth() optionalnullable.OptionalNullable[int64]

func (*Views) GetPlayerVersion added in v1.0.0

func (v *Views) GetPlayerVersion() optionalnullable.OptionalNullable[string]

func (*Views) GetPlayerWidth added in v1.0.0

func (v *Views) GetPlayerWidth() optionalnullable.OptionalNullable[PlayerWidth]

func (*Views) GetQualityOfExperienceScore added in v1.0.0

func (v *Views) GetQualityOfExperienceScore() optionalnullable.OptionalNullable[float32]

func (*Views) GetRegion added in v1.0.0

func (*Views) GetRenderQualityScore added in v1.0.0

func (v *Views) GetRenderQualityScore() optionalnullable.OptionalNullable[float32]

func (*Views) GetSessionID added in v1.0.0

func (v *Views) GetSessionID() optionalnullable.OptionalNullable[string]

func (*Views) GetStabilityScore added in v1.0.0

func (v *Views) GetStabilityScore() optionalnullable.OptionalNullable[float32]

func (*Views) GetStartupScore added in v1.0.0

func (v *Views) GetStartupScore() optionalnullable.OptionalNullable[float32]

func (*Views) GetSubPropertyID added in v1.0.0

func (v *Views) GetSubPropertyID() optionalnullable.OptionalNullable[string]

func (*Views) GetTotalWatchTime added in v1.0.0

func (v *Views) GetTotalWatchTime() optionalnullable.OptionalNullable[int64]

func (*Views) GetUpdatedTimestamp added in v1.0.0

func (v *Views) GetUpdatedTimestamp() optionalnullable.OptionalNullable[string]

func (*Views) GetUsedFullScreen added in v1.0.0

func (v *Views) GetUsedFullScreen() *bool

func (*Views) GetUserAgent added in v1.0.0

func (v *Views) GetUserAgent() optionalnullable.OptionalNullable[string]

func (*Views) GetVideoContentType added in v1.0.0

func (v *Views) GetVideoContentType() optionalnullable.OptionalNullable[string]

func (*Views) GetVideoDuration added in v1.0.0

func (v *Views) GetVideoDuration() optionalnullable.OptionalNullable[int64]

func (*Views) GetVideoID added in v1.0.0

func (v *Views) GetVideoID() optionalnullable.OptionalNullable[string]

func (*Views) GetVideoLanguage added in v1.0.0

func (v *Views) GetVideoLanguage() optionalnullable.OptionalNullable[string]

func (*Views) GetVideoResolution added in v1.0.0

func (v *Views) GetVideoResolution() optionalnullable.OptionalNullable[string]

func (*Views) GetVideoSeries added in v1.0.0

func (v *Views) GetVideoSeries() optionalnullable.OptionalNullable[string]

func (*Views) GetVideoSourceDomain added in v1.0.0

func (v *Views) GetVideoSourceDomain() optionalnullable.OptionalNullable[string]

func (*Views) GetVideoSourceDuration added in v1.0.0

func (v *Views) GetVideoSourceDuration() optionalnullable.OptionalNullable[int64]

func (*Views) GetVideoSourceHostname added in v1.0.0

func (v *Views) GetVideoSourceHostname() optionalnullable.OptionalNullable[string]

func (*Views) GetVideoSourceStreamType added in v1.0.0

func (v *Views) GetVideoSourceStreamType() optionalnullable.OptionalNullable[string]

func (*Views) GetVideoSourceType added in v1.0.0

func (v *Views) GetVideoSourceType() optionalnullable.OptionalNullable[string]

func (*Views) GetVideoSourceURL added in v1.0.0

func (v *Views) GetVideoSourceURL() optionalnullable.OptionalNullable[string]

func (*Views) GetVideoStartupFailed added in v1.0.0

func (v *Views) GetVideoStartupFailed() *bool

func (*Views) GetVideoStartupTime added in v1.0.0

func (v *Views) GetVideoStartupTime() optionalnullable.OptionalNullable[int64]

func (*Views) GetVideoTitle added in v1.0.0

func (v *Views) GetVideoTitle() optionalnullable.OptionalNullable[string]

func (*Views) GetViewEnd added in v1.0.0

func (v *Views) GetViewEnd() optionalnullable.OptionalNullable[string]

func (*Views) GetViewHasAd added in v1.0.0

func (v *Views) GetViewHasAd() *bool

func (*Views) GetViewID added in v1.0.0

func (v *Views) GetViewID() *string

func (*Views) GetViewMaxPlayheadPosition added in v1.0.0

func (v *Views) GetViewMaxPlayheadPosition() optionalnullable.OptionalNullable[int64]

func (*Views) GetViewPageURL added in v1.0.0

func (v *Views) GetViewPageURL() optionalnullable.OptionalNullable[string]

func (*Views) GetViewPlayingTime added in v1.0.0

func (v *Views) GetViewPlayingTime() optionalnullable.OptionalNullable[int64]

func (*Views) GetViewSeekedCount added in v1.0.0

func (v *Views) GetViewSeekedCount() optionalnullable.OptionalNullable[int64]

func (*Views) GetViewSeekedDuration added in v1.0.0

func (v *Views) GetViewSeekedDuration() optionalnullable.OptionalNullable[int64]

func (*Views) GetViewStart added in v1.0.0

func (v *Views) GetViewStart() optionalnullable.OptionalNullable[string]

func (*Views) GetViewTotalContentPlaybackTime added in v1.0.0

func (v *Views) GetViewTotalContentPlaybackTime() optionalnullable.OptionalNullable[int64]

func (*Views) GetViewerID added in v1.0.0

func (v *Views) GetViewerID() optionalnullable.OptionalNullable[string]

func (*Views) GetWorkspaceID added in v1.0.0

func (v *Views) GetWorkspaceID() *string

type ViewsByTopContentDetails added in v1.0.0

type ViewsByTopContentDetails struct {
	// Title of the video
	VideoTitle *string `json:"videoTitle,omitempty"`
	// Total count of view sessions for a paricular video content.
	Views *int64 `json:"views,omitempty"`
	// Total count of unique video viewers for particular video content.
	UniqueViews *int64 `json:"uniqueViews,omitempty"`
}

ViewsByTopContentDetails - Retrieves a list of the top video views

func (*ViewsByTopContentDetails) GetUniqueViews added in v1.0.0

func (v *ViewsByTopContentDetails) GetUniqueViews() *int64

func (*ViewsByTopContentDetails) GetVideoTitle added in v1.0.0

func (v *ViewsByTopContentDetails) GetVideoTitle() *string

func (*ViewsByTopContentDetails) GetViews added in v1.0.0

func (v *ViewsByTopContentDetails) GetViews() *int64

type ViewsCountResponse added in v1.0.0

type ViewsCountResponse struct {
	// Indicates whether the request was successful or not.
	Success *bool `json:"success,omitempty"`
	// Contains the view count details.
	Data *ViewsCountResponseData `json:"data,omitempty"`
}

func (*ViewsCountResponse) GetData added in v1.0.0

func (*ViewsCountResponse) GetSuccess added in v1.0.0

func (v *ViewsCountResponse) GetSuccess() *bool

type ViewsCountResponseData added in v1.0.0

type ViewsCountResponseData struct {
	// Number of views for the stream or resource.
	Views *int64 `json:"views,omitempty"`
}

ViewsCountResponseData - Contains the view count details.

func (*ViewsCountResponseData) GetViews added in v1.0.0

func (v *ViewsCountResponseData) GetViews() *int64

type ViewsList added in v1.0.0

type ViewsList struct {
	// The unique identifier for the viewing session of the user.
	//
	ViewID string `json:"viewId"`
	// Operating System signifies the software platform utilized by the viewer
	//
	OperatingSystem *string `json:"operatingSystem"`
	// The browser name of the viewer.
	//
	Application *string `json:"application"`
	// The start timestamp of the video view.
	//
	ViewStartTime *string `json:"viewStartTime"`
	// The end timestamp of the video view.
	//
	ViewEndTime *string `json:"viewEndTime"`
	// The title of the Video.
	//
	VideoTitle *string `json:"videoTitle"`
	// The code which represents specific issues or failures that occur during playback. These can be implementation specific.
	//
	ErrorCode optionalnullable.OptionalNullable[string] `json:"errorCode,omitempty"`
	// The notifications or messages that inform users or developers about issues or failures that have occurred during the playback representing error codes.
	//
	ErrorMessage optionalnullable.OptionalNullable[string] `json:"errorMessage,omitempty"`
	// The unique identifier which identifies each type of error that occurs.
	//
	ErrorID optionalnullable.OptionalNullable[int64] `json:"errorId,omitempty"`
	// Country of the viewer.
	//
	Country *string `json:"country"`
	// The watch time represents the time spent watching the video including staruptime, playback time ,buffering time.
	//
	ViewWatchTime optionalnullable.OptionalNullable[float64] `json:"viewWatchTime,omitempty"`
	// The viewer experience encapsulated in the form of score while watching the video.
	//
	QoeScore optionalnullable.OptionalNullable[float64] `json:"QoeScore,omitempty"`
}

func (*ViewsList) GetApplication added in v1.0.0

func (v *ViewsList) GetApplication() *string

func (*ViewsList) GetCountry added in v1.0.0

func (v *ViewsList) GetCountry() *string

func (*ViewsList) GetErrorCode added in v1.0.0

func (*ViewsList) GetErrorID added in v1.0.0

func (*ViewsList) GetErrorMessage added in v1.0.0

func (v *ViewsList) GetErrorMessage() optionalnullable.OptionalNullable[string]

func (*ViewsList) GetOperatingSystem added in v1.0.0

func (v *ViewsList) GetOperatingSystem() *string

func (*ViewsList) GetQoeScore added in v1.0.0

func (*ViewsList) GetVideoTitle added in v1.0.0

func (v *ViewsList) GetVideoTitle() *string

func (*ViewsList) GetViewEndTime added in v1.0.0

func (v *ViewsList) GetViewEndTime() *string

func (*ViewsList) GetViewID added in v1.0.0

func (v *ViewsList) GetViewID() string

func (*ViewsList) GetViewStartTime added in v1.0.0

func (v *ViewsList) GetViewStartTime() *string

func (*ViewsList) GetViewWatchTime added in v1.0.0

func (v *ViewsList) GetViewWatchTime() optionalnullable.OptionalNullable[float64]

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 (w *WatermarkInput) GetHeight() *string

func (*WatermarkInput) GetOpacity

func (w *WatermarkInput) GetOpacity() *string

func (*WatermarkInput) GetPlacement

func (w *WatermarkInput) GetPlacement() *Placement

func (*WatermarkInput) GetType

func (w *WatermarkInput) GetType() *WatermarkInputType

func (*WatermarkInput) GetURL

func (w *WatermarkInput) GetURL() *string

func (*WatermarkInput) GetWidth

func (w *WatermarkInput) GetWidth() *string

func (WatermarkInput) MarshalJSON added in v1.0.0

func (w WatermarkInput) MarshalJSON() ([]byte, error)

func (*WatermarkInput) UnmarshalJSON added in v1.0.0

func (w *WatermarkInput) UnmarshalJSON(data []byte) error

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

Source Files

Jump to

Keyboard shortcuts

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