Documentation
¶
Index ¶
- Constants
- Variables
- type AddMediaToPlaylistRequest
- type AddMediaToPlaylistResponse
- type AddMediaTrackRequest
- type AddMediaTrackRequestBody
- type AddMediaTrackResponse
- type AddMediaTrackResponseBody
- type CancelUploadRequest
- type CancelUploadResponse
- type CancelUploadResponseBody
- type ChangeMediaOrderInPlaylistRequest
- type ChangeMediaOrderInPlaylistResponse
- type CompleteLiveStreamRequest
- type CompleteLiveStreamResponse
- type CreateAPlaylistResponse
- type CreateMediaPlaybackIDAccessRestrictions
- type CreateMediaPlaybackIDData
- type CreateMediaPlaybackIDRequest
- type CreateMediaPlaybackIDRequestBody
- func (c *CreateMediaPlaybackIDRequestBody) GetAccessPolicy() components.AccessPolicy
- func (c *CreateMediaPlaybackIDRequestBody) GetAccessRestrictions() *CreateMediaPlaybackIDAccessRestrictions
- func (c *CreateMediaPlaybackIDRequestBody) GetDrmConfigurationID() *string
- func (c *CreateMediaPlaybackIDRequestBody) GetResolution() *Resolution
- type CreateMediaPlaybackIDResponse
- type CreateMediaPlaybackIDResponseBody
- type CreateMediaResponse
- type CreateNewStreamResponse
- type CreatePlaybackIDOfStreamRequest
- type CreatePlaybackIDOfStreamResponse
- type CreateSigningKeyResponse
- type CreateSimulcastOfStreamRequest
- type CreateSimulcastOfStreamResponse
- type DeleteAPlaylistRequest
- type DeleteAPlaylistResponse
- type DeleteLiveStreamRequest
- type DeleteLiveStreamResponse
- type DeleteMediaFromPlaylistRequest
- type DeleteMediaFromPlaylistResponse
- type DeleteMediaPlaybackIDRequest
- type DeleteMediaPlaybackIDResponse
- type DeleteMediaPlaybackIDResponseBody
- type DeleteMediaRequest
- type DeleteMediaResponse
- type DeleteMediaResponseBody
- type DeleteMediaTrackRequest
- type DeleteMediaTrackResponse
- type DeleteMediaTrackResponseBody
- type DeletePlaybackIDOfStreamRequest
- type DeletePlaybackIDOfStreamResponse
- type DeleteSigningKeyRequest
- type DeleteSigningKeyResponse
- type DeleteSimulcastOfStreamRequest
- type DeleteSimulcastOfStreamResponse
- type DimensionsID
- type DirectUploadVideoMediaAccessRestrictions
- type DirectUploadVideoMediaModeration
- type DirectUploadVideoMediaMp4Support
- type DirectUploadVideoMediaRequest
- type DirectUploadVideoMediaResponse
- type DirectUploadVideoMediaResponseBody
- type DisableLiveStreamRequest
- type DisableLiveStreamResponse
- type EnableLiveStreamRequest
- type EnableLiveStreamResponse
- type ErrorCode
- type ErrorCodeType
- type GenerateSubtitleTrackRequest
- type GenerateSubtitleTrackResponse
- type GenerateSubtitleTrackResponseBody
- type GetAllPlaylistsRequest
- type GetAllPlaylistsResponse
- type GetAllStreamsRequest
- type GetAllStreamsResponse
- type GetDataViewlistCurrentViewsFilterData
- type GetDataViewlistCurrentViewsFilterDimension
- type GetDataViewlistCurrentViewsFilterRequest
- func (g *GetDataViewlistCurrentViewsFilterRequest) GetDimension() *GetDataViewlistCurrentViewsFilterDimension
- func (g *GetDataViewlistCurrentViewsFilterRequest) GetLimit() *int64
- func (g GetDataViewlistCurrentViewsFilterRequest) MarshalJSON() ([]byte, error)
- func (g *GetDataViewlistCurrentViewsFilterRequest) UnmarshalJSON(data []byte) error
- type GetDataViewlistCurrentViewsFilterResponse
- type GetDataViewlistCurrentViewsFilterResponseBody
- type GetDataViewlistCurrentViewsGetTimeseriesViewsData
- func (g *GetDataViewlistCurrentViewsGetTimeseriesViewsData) GetIntervalTime() *time.Time
- func (g *GetDataViewlistCurrentViewsGetTimeseriesViewsData) GetMetricValue() optionalnullable.OptionalNullable[int64]
- func (g *GetDataViewlistCurrentViewsGetTimeseriesViewsData) GetNumberOfViews() *int64
- func (g GetDataViewlistCurrentViewsGetTimeseriesViewsData) MarshalJSON() ([]byte, error)
- func (g *GetDataViewlistCurrentViewsGetTimeseriesViewsData) UnmarshalJSON(data []byte) error
- type GetDataViewlistCurrentViewsGetTimeseriesViewsResponse
- type GetDataViewlistCurrentViewsGetTimeseriesViewsResponseBody
- func (g *GetDataViewlistCurrentViewsGetTimeseriesViewsResponseBody) GetData() []GetDataViewlistCurrentViewsGetTimeseriesViewsData
- func (g *GetDataViewlistCurrentViewsGetTimeseriesViewsResponseBody) GetSuccess() *bool
- func (g *GetDataViewlistCurrentViewsGetTimeseriesViewsResponseBody) GetTimespan() []int64
- type GetDrmConfigurationByIDRequest
- type GetDrmConfigurationByIDResponse
- type GetDrmConfigurationByIDResponseBody
- type GetDrmConfigurationRequest
- type GetDrmConfigurationResponse
- type GetDrmConfigurationResponseBody
- type GetLiveStreamByIDRequest
- type GetLiveStreamByIDResponse
- type GetLiveStreamPlaybackIDRequest
- type GetLiveStreamPlaybackIDResponse
- type GetLiveStreamViewerCountByIDRequest
- type GetLiveStreamViewerCountByIDResponse
- type GetMediaClipsRequest
- func (g *GetMediaClipsRequest) GetLimit() *int64
- func (g *GetMediaClipsRequest) GetOffset() *int64
- func (g *GetMediaClipsRequest) GetOrderBy() *components.SortOrder
- func (g *GetMediaClipsRequest) GetSourceMediaID() string
- func (g GetMediaClipsRequest) MarshalJSON() ([]byte, error)
- func (g *GetMediaClipsRequest) UnmarshalJSON(data []byte) error
- type GetMediaClipsResponse
- type GetMediaRequest
- type GetMediaResponse
- type GetMediaResponseBody
- type GetPlaybackIDData
- type GetPlaybackIDRequest
- type GetPlaybackIDResponse
- type GetPlaybackIDResponseBody
- type GetPlaylistByIDRequest
- type GetPlaylistByIDResponse
- type GetSigningKeyByIDRequest
- type GetSigningKeyByIDResponse
- type GetSpecificSimulcastOfStreamRequest
- type GetSpecificSimulcastOfStreamResponse
- type GetTimeseriesDataMetricID
- type GetTimeseriesDataRequest
- func (g *GetTimeseriesDataRequest) GetFilterby() *string
- func (g *GetTimeseriesDataRequest) GetGroupBy() *GroupBy
- func (g *GetTimeseriesDataRequest) GetMeasurement() *string
- func (g *GetTimeseriesDataRequest) GetMetricID() GetTimeseriesDataMetricID
- func (g *GetTimeseriesDataRequest) GetSortOrder() *GetTimeseriesDataSortOrder
- func (g *GetTimeseriesDataRequest) GetTimespan() GetTimeseriesDataTimespan
- func (g GetTimeseriesDataRequest) MarshalJSON() ([]byte, error)
- func (g *GetTimeseriesDataRequest) UnmarshalJSON(data []byte) error
- type GetTimeseriesDataResponse
- type GetTimeseriesDataResponseBody
- func (g *GetTimeseriesDataResponseBody) GetData() []components.MetricsTimeseriesDataDetails
- func (g *GetTimeseriesDataResponseBody) GetMetaData() *components.MetricsTimeseriesMetaDataDetails
- func (g *GetTimeseriesDataResponseBody) GetSuccess() *bool
- func (g *GetTimeseriesDataResponseBody) GetTimespan() []int64
- type GetTimeseriesDataSortOrder
- type GetTimeseriesDataTimespan
- type GetVideoViewDetailsRequest
- type GetVideoViewDetailsResponse
- type GetVideoViewDetailsResponseBody
- type GroupBy
- type Input
- type InputType
- type LanguageCode
- type ListBreakdownValuesMetricID
- type ListBreakdownValuesRequest
- func (l *ListBreakdownValuesRequest) GetFilterby() *string
- func (l *ListBreakdownValuesRequest) GetGroupBy() *string
- func (l *ListBreakdownValuesRequest) GetLimit() *int64
- func (l *ListBreakdownValuesRequest) GetMeasurement() *string
- func (l *ListBreakdownValuesRequest) GetMetricID() ListBreakdownValuesMetricID
- func (l *ListBreakdownValuesRequest) GetOffset() *int64
- func (l *ListBreakdownValuesRequest) GetOrderBy() *string
- func (l *ListBreakdownValuesRequest) GetSortOrder() *ListBreakdownValuesSortOrder
- func (l *ListBreakdownValuesRequest) GetTimespan() ListBreakdownValuesTimespan
- func (l ListBreakdownValuesRequest) MarshalJSON() ([]byte, error)
- func (l *ListBreakdownValuesRequest) UnmarshalJSON(data []byte) error
- type ListBreakdownValuesResponse
- type ListBreakdownValuesResponseBody
- func (l *ListBreakdownValuesResponseBody) GetData() []components.MetricsBreakdownDetails
- func (l *ListBreakdownValuesResponseBody) GetMetaData() *components.MetricsTimeseriesMetaDataDetails
- func (l *ListBreakdownValuesResponseBody) GetSuccess() *bool
- func (l *ListBreakdownValuesResponseBody) GetTimespan() []int64
- type ListBreakdownValuesSortOrder
- type ListBreakdownValuesTimespan
- type ListByTopContentRequest
- func (l *ListByTopContentRequest) GetFilterby() *string
- func (l *ListByTopContentRequest) GetLimit() *int64
- func (l *ListByTopContentRequest) GetTimespan() ListByTopContentTimespan
- func (l ListByTopContentRequest) MarshalJSON() ([]byte, error)
- func (l *ListByTopContentRequest) UnmarshalJSON(data []byte) error
- type ListByTopContentResponse
- type ListByTopContentResponseBody
- type ListByTopContentTimespan
- type ListComparisonValuesDimension
- type ListComparisonValuesRequest
- type ListComparisonValuesResponse
- type ListComparisonValuesResponseBody
- type ListComparisonValuesTimespan
- type ListDimensionsResponse
- type ListDimensionsResponseBody
- type ListErrorsData
- type ListErrorsRequest
- type ListErrorsResponse
- type ListErrorsResponseBody
- type ListErrorsTimespan
- type ListFilterValuesForDimensionRequest
- type ListFilterValuesForDimensionResponse
- type ListFilterValuesForDimensionResponseBody
- type ListFilterValuesForDimensionTimespan
- type ListLiveClipsRequest
- func (l *ListLiveClipsRequest) GetLimit() *int64
- func (l *ListLiveClipsRequest) GetLivestreamID() string
- func (l *ListLiveClipsRequest) GetOffset() *int64
- func (l *ListLiveClipsRequest) GetOrderBy() *components.SortOrder
- func (l ListLiveClipsRequest) MarshalJSON() ([]byte, error)
- func (l *ListLiveClipsRequest) UnmarshalJSON(data []byte) error
- type ListLiveClipsResponse
- type ListLiveClipsResponseBody
- type ListMediaRequest
- type ListMediaResponse
- type ListMediaResponseBody
- type ListOverallValuesMetricID
- type ListOverallValuesRequest
- func (l *ListOverallValuesRequest) GetFilterby() *string
- func (l *ListOverallValuesRequest) GetMeasurement() *string
- func (l *ListOverallValuesRequest) GetMetricID() ListOverallValuesMetricID
- func (l *ListOverallValuesRequest) GetTimespan() ListOverallValuesTimespan
- func (l ListOverallValuesRequest) MarshalJSON() ([]byte, error)
- func (l *ListOverallValuesRequest) UnmarshalJSON(data []byte) error
- type ListOverallValuesResponse
- type ListOverallValuesResponseBody
- func (l *ListOverallValuesResponseBody) GetData() *components.MetricsOverallDataDetails
- func (l *ListOverallValuesResponseBody) GetMetaData() *components.MetricsOverallMetaDataDetails
- func (l *ListOverallValuesResponseBody) GetSuccess() *bool
- func (l *ListOverallValuesResponseBody) GetTimespan() []int64
- type ListOverallValuesTimespan
- type ListSigningKeysRequest
- type ListSigningKeysResponse
- type ListUploadsRequest
- type ListUploadsResponse
- type ListUploadsResponseBody
- type ListVideoViewsRequest
- func (l *ListVideoViewsRequest) GetErrorCode() optionalnullable.OptionalNullable[ErrorCode]
- func (l *ListVideoViewsRequest) GetFilterby() *string
- func (l *ListVideoViewsRequest) GetLimit() *int64
- func (l *ListVideoViewsRequest) GetOffset() *int64
- func (l *ListVideoViewsRequest) GetOrderBy() *string
- func (l *ListVideoViewsRequest) GetSortOrder() *string
- func (l *ListVideoViewsRequest) GetTimespan() ListVideoViewsTimespan
- func (l *ListVideoViewsRequest) GetViewerID() *string
- func (l ListVideoViewsRequest) MarshalJSON() ([]byte, error)
- func (l *ListVideoViewsRequest) UnmarshalJSON(data []byte) error
- type ListVideoViewsResponse
- type ListVideoViewsResponseBody
- type ListVideoViewsTimespan
- type MaxResolution
- type Option
- func WithOperationTimeout(timeout time.Duration) Option
- func WithRetries(config retry.Config) Option
- func WithServerURL(serverURL string) Option
- func WithSetHeaders(hdrs map[string]string) Option
- func WithTemplatedServerURL(serverURL string, params map[string]string) Option
- func WithURLOverride(urlOverride string) Option
- type Options
- type OrderBy
- type PushMediaSettings
- func (p *PushMediaSettings) GetAccessPolicy() components.BasicAccessPolicy
- func (p *PushMediaSettings) GetAccessRestrictions() *DirectUploadVideoMediaAccessRestrictions
- func (p *PushMediaSettings) GetChapters() *bool
- func (p *PushMediaSettings) GetEndTime() *float64
- func (p *PushMediaSettings) GetInputs() []Input
- func (p *PushMediaSettings) GetMaxResolution() *MaxResolution
- func (p *PushMediaSettings) GetMetadata() map[string]string
- func (p *PushMediaSettings) GetModeration() *DirectUploadVideoMediaModeration
- func (p *PushMediaSettings) GetMp4Support() *DirectUploadVideoMediaMp4Support
- func (p *PushMediaSettings) GetNamedEntities() *bool
- func (p *PushMediaSettings) GetOptimizeAudio() *bool
- func (p *PushMediaSettings) GetSourceAccess() *bool
- func (p *PushMediaSettings) GetStartTime() *float64
- func (p *PushMediaSettings) GetSubtitles() *Subtitles
- func (p *PushMediaSettings) GetSummary() *Summary
- func (p PushMediaSettings) MarshalJSON() ([]byte, error)
- func (p *PushMediaSettings) UnmarshalJSON(data []byte) error
- type Resolution
- type RetrieveMediaInputInfoData
- type RetrieveMediaInputInfoRequest
- type RetrieveMediaInputInfoResponse
- type RetrieveMediaInputInfoResponseBody
- type Subtitles
- type Summary
- type UpdateAPlaylistRequest
- type UpdateAPlaylistResponse
- type UpdateLiveStreamRequest
- type UpdateLiveStreamResponse
- type UpdateMediaChaptersRequest
- type UpdateMediaChaptersRequestBody
- type UpdateMediaChaptersResponse
- type UpdateMediaChaptersResponseBody
- type UpdateMediaModerationModeration
- type UpdateMediaModerationRequest
- type UpdateMediaModerationRequestBody
- type UpdateMediaModerationResponse
- type UpdateMediaModerationResponseBody
- type UpdateMediaNamedEntitiesRequest
- type UpdateMediaNamedEntitiesRequestBody
- type UpdateMediaNamedEntitiesResponse
- type UpdateMediaNamedEntitiesResponseBody
- type UpdateMediaSummaryRequest
- type UpdateMediaSummaryRequestBody
- type UpdateMediaSummaryResponse
- type UpdateMediaSummaryResponseBody
- type UpdateMediaTrackRequest
- type UpdateMediaTrackResponse
- type UpdateMediaTrackResponseBody
- type UpdateSpecificSimulcastOfStreamRequest
- type UpdateSpecificSimulcastOfStreamResponse
- type UpdatedMediaRequest
- type UpdatedMediaRequestBody
- type UpdatedMediaResponse
- type UpdatedMediaResponseBody
- type UpdatedMp4SupportMp4Support
- type UpdatedMp4SupportRequest
- type UpdatedMp4SupportRequestBody
- type UpdatedMp4SupportResponse
- type UpdatedMp4SupportResponseBody
- type UpdatedSourceAccessRequest
- type UpdatedSourceAccessRequestBody
- type UpdatedSourceAccessResponse
- type UpdatedSourceAccessResponseBody
Constants ¶
const ( SupportedOptionRetries = "retries" SupportedOptionTimeout = "timeout" SupportedOptionAcceptHeaderOverride = "acceptHeaderOverride" SupportedOptionURLOverride = "urlOverride" )
Variables ¶
var ErrUnsupportedOption = errors.New("unsupported option")
Functions ¶
This section is empty.
Types ¶
type AddMediaToPlaylistRequest ¶ added in v1.0.0
type AddMediaToPlaylistRequest struct {
// The unique id of the playlist you want to perform the operation on.
PlaylistID string `pathParam:"style=simple,explode=false,name=playlistId"`
MediaIdsRequest components.MediaIdsRequest `request:"mediaType=application/json"`
}
func (*AddMediaToPlaylistRequest) GetMediaIdsRequest ¶ added in v1.0.0
func (a *AddMediaToPlaylistRequest) GetMediaIdsRequest() components.MediaIdsRequest
func (*AddMediaToPlaylistRequest) GetPlaylistID ¶ added in v1.0.0
func (a *AddMediaToPlaylistRequest) GetPlaylistID() string
type AddMediaToPlaylistResponse ¶ added in v1.0.0
type AddMediaToPlaylistResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Added media to playlist successfully
PlaylistByIDResponse *components.PlaylistByIDResponse
}
func (*AddMediaToPlaylistResponse) GetHTTPMeta ¶ added in v1.0.0
func (a *AddMediaToPlaylistResponse) GetHTTPMeta() components.HTTPMetadata
func (*AddMediaToPlaylistResponse) GetPlaylistByIDResponse ¶ added in v1.0.0
func (a *AddMediaToPlaylistResponse) GetPlaylistByIDResponse() *components.PlaylistByIDResponse
type AddMediaTrackRequest ¶ added in v1.0.0
type AddMediaTrackRequest struct {
// When creating the media, FastPix assigns a universally unique identifier with a maximum length of 255 characters.
MediaID string `pathParam:"style=simple,explode=false,name=mediaId"`
RequestBody AddMediaTrackRequestBody `request:"mediaType=application/json"`
}
func (*AddMediaTrackRequest) GetMediaID ¶ added in v1.0.0
func (a *AddMediaTrackRequest) GetMediaID() string
func (*AddMediaTrackRequest) GetRequestBody ¶ added in v1.0.0
func (a *AddMediaTrackRequest) GetRequestBody() AddMediaTrackRequestBody
type AddMediaTrackRequestBody ¶ added in v1.0.0
type AddMediaTrackRequestBody struct {
// Contains details about the track being added to the media file.
Tracks *components.AddTrackRequest `json:"tracks,omitempty"`
}
func (*AddMediaTrackRequestBody) GetTracks ¶ added in v1.0.0
func (a *AddMediaTrackRequestBody) GetTracks() *components.AddTrackRequest
type AddMediaTrackResponse ¶ added in v1.0.0
type AddMediaTrackResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Media details updated successfully
Object *AddMediaTrackResponseBody
}
func (*AddMediaTrackResponse) GetHTTPMeta ¶ added in v1.0.0
func (a *AddMediaTrackResponse) GetHTTPMeta() components.HTTPMetadata
func (*AddMediaTrackResponse) GetObject ¶ added in v1.0.0
func (a *AddMediaTrackResponse) GetObject() *AddMediaTrackResponseBody
type AddMediaTrackResponseBody ¶ added in v1.0.0
type AddMediaTrackResponseBody struct {
// Demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
// Contains details about the track that was added or updated.
Data *components.AddTrackResponse `json:"data,omitempty"`
}
AddMediaTrackResponseBody - Media details updated successfully
func (*AddMediaTrackResponseBody) GetData ¶ added in v1.0.0
func (a *AddMediaTrackResponseBody) GetData() *components.AddTrackResponse
func (*AddMediaTrackResponseBody) GetSuccess ¶ added in v1.0.0
func (a *AddMediaTrackResponseBody) GetSuccess() *bool
type CancelUploadRequest ¶ added in v1.0.0
type CancelUploadRequest struct {
// When uploading the media, FastPix assigns a universally unique identifier with a maximum length of 255 characters.
UploadID string `pathParam:"style=simple,explode=false,name=uploadId"`
}
func (*CancelUploadRequest) GetUploadID ¶ added in v1.0.0
func (c *CancelUploadRequest) GetUploadID() string
type CancelUploadResponse ¶ added in v1.0.0
type CancelUploadResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Upload cancelled successfully
Object *CancelUploadResponseBody
}
func (*CancelUploadResponse) GetHTTPMeta ¶ added in v1.0.0
func (c *CancelUploadResponse) GetHTTPMeta() components.HTTPMetadata
func (*CancelUploadResponse) GetObject ¶ added in v1.0.0
func (c *CancelUploadResponse) GetObject() *CancelUploadResponseBody
type CancelUploadResponseBody ¶ added in v1.0.0
type CancelUploadResponseBody struct {
// Demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
// Response returned when an upload is cancelled.
Data *components.MediaCancelResponse `json:"data,omitempty"`
}
CancelUploadResponseBody - Upload cancelled successfully
func (*CancelUploadResponseBody) GetData ¶ added in v1.0.0
func (c *CancelUploadResponseBody) GetData() *components.MediaCancelResponse
func (*CancelUploadResponseBody) GetSuccess ¶ added in v1.0.0
func (c *CancelUploadResponseBody) GetSuccess() *bool
type ChangeMediaOrderInPlaylistRequest ¶ added in v1.0.0
type ChangeMediaOrderInPlaylistRequest struct {
// The unique id of the playlist you want to perform the operation on.
PlaylistID string `pathParam:"style=simple,explode=false,name=playlistId"`
MediaIdsRequest components.MediaIdsRequest `request:"mediaType=application/json"`
}
func (*ChangeMediaOrderInPlaylistRequest) GetMediaIdsRequest ¶ added in v1.0.0
func (c *ChangeMediaOrderInPlaylistRequest) GetMediaIdsRequest() components.MediaIdsRequest
func (*ChangeMediaOrderInPlaylistRequest) GetPlaylistID ¶ added in v1.0.0
func (c *ChangeMediaOrderInPlaylistRequest) GetPlaylistID() string
type ChangeMediaOrderInPlaylistResponse ¶ added in v1.0.0
type ChangeMediaOrderInPlaylistResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Added media to playlist successfully
PlaylistByIDResponse *components.PlaylistByIDResponse
}
func (*ChangeMediaOrderInPlaylistResponse) GetHTTPMeta ¶ added in v1.0.0
func (c *ChangeMediaOrderInPlaylistResponse) GetHTTPMeta() components.HTTPMetadata
func (*ChangeMediaOrderInPlaylistResponse) GetPlaylistByIDResponse ¶ added in v1.0.0
func (c *ChangeMediaOrderInPlaylistResponse) GetPlaylistByIDResponse() *components.PlaylistByIDResponse
type CompleteLiveStreamRequest ¶ added in v1.0.0
type CompleteLiveStreamRequest struct {
// Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
StreamID string `pathParam:"style=simple,explode=false,name=streamId"`
}
func (*CompleteLiveStreamRequest) GetStreamID ¶ added in v1.0.0
func (c *CompleteLiveStreamRequest) GetStreamID() string
type CompleteLiveStreamResponse ¶ added in v1.0.0
type CompleteLiveStreamResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Stream details updated successfully
LiveStreamDeleteResponse *components.LiveStreamDeleteResponse
}
func (*CompleteLiveStreamResponse) GetHTTPMeta ¶ added in v1.0.0
func (c *CompleteLiveStreamResponse) GetHTTPMeta() components.HTTPMetadata
func (*CompleteLiveStreamResponse) GetLiveStreamDeleteResponse ¶ added in v1.0.0
func (c *CompleteLiveStreamResponse) GetLiveStreamDeleteResponse() *components.LiveStreamDeleteResponse
type CreateAPlaylistResponse ¶ added in v1.0.0
type CreateAPlaylistResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Playlist created successfully
PlaylistCreatedResponse *components.PlaylistCreatedResponse
}
func (*CreateAPlaylistResponse) GetHTTPMeta ¶ added in v1.0.0
func (c *CreateAPlaylistResponse) GetHTTPMeta() components.HTTPMetadata
func (*CreateAPlaylistResponse) GetPlaylistCreatedResponse ¶ added in v1.0.0
func (c *CreateAPlaylistResponse) GetPlaylistCreatedResponse() *components.PlaylistCreatedResponse
type CreateMediaPlaybackIDAccessRestrictions ¶
type CreateMediaPlaybackIDAccessRestrictions struct {
// Restrictions based on the originating domain of a request
Domains *components.DomainRestrictions `json:"domains,omitempty"`
// Restrictions based on the user agent
UserAgents *components.UserAgentRestrictions `json:"userAgents,omitempty"`
}
func (*CreateMediaPlaybackIDAccessRestrictions) GetDomains ¶
func (c *CreateMediaPlaybackIDAccessRestrictions) GetDomains() *components.DomainRestrictions
func (*CreateMediaPlaybackIDAccessRestrictions) GetUserAgents ¶
func (c *CreateMediaPlaybackIDAccessRestrictions) GetUserAgents() *components.UserAgentRestrictions
type CreateMediaPlaybackIDData ¶ added in v1.0.0
type CreateMediaPlaybackIDData struct {
// A collection of Playback ID objects utilized for crafting HLS playback URLs.
PlaybackIds []components.PlaybackID `json:"playbackIds,omitempty"`
}
CreateMediaPlaybackIDData - Displays the result of the request.
func (*CreateMediaPlaybackIDData) GetPlaybackIds ¶ added in v1.0.0
func (c *CreateMediaPlaybackIDData) GetPlaybackIds() []components.PlaybackID
type CreateMediaPlaybackIDRequest ¶
type CreateMediaPlaybackIDRequest struct {
// When creating the media, FastPix assigns a universally unique identifier with a maximum length of 255 characters.
MediaID string `pathParam:"style=simple,explode=false,name=mediaId"`
// Request body for creating playback id for an media
RequestBody *CreateMediaPlaybackIDRequestBody `request:"mediaType=application/json"`
}
func (*CreateMediaPlaybackIDRequest) GetMediaID ¶
func (c *CreateMediaPlaybackIDRequest) GetMediaID() string
func (*CreateMediaPlaybackIDRequest) GetRequestBody ¶
func (c *CreateMediaPlaybackIDRequest) GetRequestBody() *CreateMediaPlaybackIDRequestBody
type CreateMediaPlaybackIDRequestBody ¶
type CreateMediaPlaybackIDRequestBody struct {
// Access policy for media content
AccessPolicy components.AccessPolicy `json:"accessPolicy"`
AccessRestrictions *CreateMediaPlaybackIDAccessRestrictions `json:"accessRestrictions,omitempty"`
// DRM configuration ID (required if accessPolicy is 'drm')
DrmConfigurationID *string `json:"drmConfigurationId,omitempty"`
// The maximum resolution for the playback ID.
Resolution *Resolution `json:"resolution,omitempty"`
}
CreateMediaPlaybackIDRequestBody - Request body for creating playback id for an media
func (*CreateMediaPlaybackIDRequestBody) GetAccessPolicy ¶
func (c *CreateMediaPlaybackIDRequestBody) GetAccessPolicy() components.AccessPolicy
func (*CreateMediaPlaybackIDRequestBody) GetAccessRestrictions ¶
func (c *CreateMediaPlaybackIDRequestBody) GetAccessRestrictions() *CreateMediaPlaybackIDAccessRestrictions
func (*CreateMediaPlaybackIDRequestBody) GetDrmConfigurationID ¶ added in v1.0.0
func (c *CreateMediaPlaybackIDRequestBody) GetDrmConfigurationID() *string
func (*CreateMediaPlaybackIDRequestBody) GetResolution ¶ added in v1.0.0
func (c *CreateMediaPlaybackIDRequestBody) GetResolution() *Resolution
type CreateMediaPlaybackIDResponse ¶
type CreateMediaPlaybackIDResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Playback id for an media
Object *CreateMediaPlaybackIDResponseBody
}
func (*CreateMediaPlaybackIDResponse) GetHTTPMeta ¶
func (c *CreateMediaPlaybackIDResponse) GetHTTPMeta() components.HTTPMetadata
func (*CreateMediaPlaybackIDResponse) GetObject ¶
func (c *CreateMediaPlaybackIDResponse) GetObject() *CreateMediaPlaybackIDResponseBody
type CreateMediaPlaybackIDResponseBody ¶
type CreateMediaPlaybackIDResponseBody struct {
// Demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
// Displays the result of the request.
Data *CreateMediaPlaybackIDData `json:"data,omitempty"`
}
CreateMediaPlaybackIDResponseBody - Playback id for an media
func (*CreateMediaPlaybackIDResponseBody) GetData ¶
func (c *CreateMediaPlaybackIDResponseBody) GetData() *CreateMediaPlaybackIDData
func (*CreateMediaPlaybackIDResponseBody) GetSuccess ¶
func (c *CreateMediaPlaybackIDResponseBody) GetSuccess() *bool
type CreateMediaResponse ¶
type CreateMediaResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Media is created successfully
CreateMediaSuccessResponse *components.CreateMediaSuccessResponse
}
func (*CreateMediaResponse) GetCreateMediaSuccessResponse ¶ added in v1.0.0
func (c *CreateMediaResponse) GetCreateMediaSuccessResponse() *components.CreateMediaSuccessResponse
func (*CreateMediaResponse) GetHTTPMeta ¶
func (c *CreateMediaResponse) GetHTTPMeta() components.HTTPMetadata
type CreateNewStreamResponse ¶
type CreateNewStreamResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Stream created successfully
LiveStreamResponseDTO *components.LiveStreamResponseDTO
}
func (*CreateNewStreamResponse) GetHTTPMeta ¶
func (c *CreateNewStreamResponse) GetHTTPMeta() components.HTTPMetadata
func (*CreateNewStreamResponse) GetLiveStreamResponseDTO ¶
func (c *CreateNewStreamResponse) GetLiveStreamResponseDTO() *components.LiveStreamResponseDTO
type CreatePlaybackIDOfStreamRequest ¶
type CreatePlaybackIDOfStreamRequest struct {
// Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
StreamID string `pathParam:"style=simple,explode=false,name=streamId"`
PlaybackIDRequest components.PlaybackIDRequest `request:"mediaType=application/json"`
}
func (*CreatePlaybackIDOfStreamRequest) GetPlaybackIDRequest ¶
func (c *CreatePlaybackIDOfStreamRequest) GetPlaybackIDRequest() components.PlaybackIDRequest
func (*CreatePlaybackIDOfStreamRequest) GetStreamID ¶
func (c *CreatePlaybackIDOfStreamRequest) GetStreamID() string
type CreatePlaybackIDOfStreamResponse ¶
type CreatePlaybackIDOfStreamResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// New PlaybackId created successfully
PlaybackIDSuccessResponse *components.PlaybackIDSuccessResponse
}
func (*CreatePlaybackIDOfStreamResponse) GetHTTPMeta ¶
func (c *CreatePlaybackIDOfStreamResponse) GetHTTPMeta() components.HTTPMetadata
func (*CreatePlaybackIDOfStreamResponse) GetPlaybackIDSuccessResponse ¶ added in v1.0.0
func (c *CreatePlaybackIDOfStreamResponse) GetPlaybackIDSuccessResponse() *components.PlaybackIDSuccessResponse
type CreateSigningKeyResponse ¶ added in v1.0.0
type CreateSigningKeyResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// created a signing key successfully
CreateResponse *components.CreateResponse
}
func (*CreateSigningKeyResponse) GetCreateResponse ¶ added in v1.0.0
func (c *CreateSigningKeyResponse) GetCreateResponse() *components.CreateResponse
func (*CreateSigningKeyResponse) GetHTTPMeta ¶ added in v1.0.0
func (c *CreateSigningKeyResponse) GetHTTPMeta() components.HTTPMetadata
type CreateSimulcastOfStreamRequest ¶
type CreateSimulcastOfStreamRequest struct {
// Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
StreamID string `pathParam:"style=simple,explode=false,name=streamId"`
SimulcastRequest components.SimulcastRequest `request:"mediaType=application/json"`
}
func (*CreateSimulcastOfStreamRequest) GetSimulcastRequest ¶
func (c *CreateSimulcastOfStreamRequest) GetSimulcastRequest() components.SimulcastRequest
func (*CreateSimulcastOfStreamRequest) GetStreamID ¶
func (c *CreateSimulcastOfStreamRequest) GetStreamID() string
type CreateSimulcastOfStreamResponse ¶
type CreateSimulcastOfStreamResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// New Simulcast created successfully
SimulcastResponse *components.SimulcastResponse
}
func (*CreateSimulcastOfStreamResponse) GetHTTPMeta ¶
func (c *CreateSimulcastOfStreamResponse) GetHTTPMeta() components.HTTPMetadata
func (*CreateSimulcastOfStreamResponse) GetSimulcastResponse ¶
func (c *CreateSimulcastOfStreamResponse) GetSimulcastResponse() *components.SimulcastResponse
type DeleteAPlaylistRequest ¶ added in v1.0.0
type DeleteAPlaylistRequest struct {
// The unique id of the playlist you want to delete.
PlaylistID string `pathParam:"style=simple,explode=false,name=playlistId"`
}
func (*DeleteAPlaylistRequest) GetPlaylistID ¶ added in v1.0.0
func (d *DeleteAPlaylistRequest) GetPlaylistID() string
type DeleteAPlaylistResponse ¶ added in v1.0.0
type DeleteAPlaylistResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Playlist deleted successfully
SuccessResponse *components.SuccessResponse
}
func (*DeleteAPlaylistResponse) GetHTTPMeta ¶ added in v1.0.0
func (d *DeleteAPlaylistResponse) GetHTTPMeta() components.HTTPMetadata
func (*DeleteAPlaylistResponse) GetSuccessResponse ¶ added in v1.0.0
func (d *DeleteAPlaylistResponse) GetSuccessResponse() *components.SuccessResponse
type DeleteLiveStreamRequest ¶
type DeleteLiveStreamRequest struct {
// Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
StreamID string `pathParam:"style=simple,explode=false,name=streamId"`
}
func (*DeleteLiveStreamRequest) GetStreamID ¶
func (d *DeleteLiveStreamRequest) GetStreamID() string
type DeleteLiveStreamResponse ¶
type DeleteLiveStreamResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Stream deleted successfully
LiveStreamDeleteResponse *components.LiveStreamDeleteResponse
}
func (*DeleteLiveStreamResponse) GetHTTPMeta ¶
func (d *DeleteLiveStreamResponse) GetHTTPMeta() components.HTTPMetadata
func (*DeleteLiveStreamResponse) GetLiveStreamDeleteResponse ¶
func (d *DeleteLiveStreamResponse) GetLiveStreamDeleteResponse() *components.LiveStreamDeleteResponse
type DeleteMediaFromPlaylistRequest ¶ added in v1.0.0
type DeleteMediaFromPlaylistRequest struct {
// The unique id of the playlist you want to perform the operation on.
PlaylistID string `pathParam:"style=simple,explode=false,name=playlistId"`
MediaIdsRequest *components.MediaIdsRequest `request:"mediaType=application/json"`
}
func (*DeleteMediaFromPlaylistRequest) GetMediaIdsRequest ¶ added in v1.0.0
func (d *DeleteMediaFromPlaylistRequest) GetMediaIdsRequest() *components.MediaIdsRequest
func (*DeleteMediaFromPlaylistRequest) GetPlaylistID ¶ added in v1.0.0
func (d *DeleteMediaFromPlaylistRequest) GetPlaylistID() string
type DeleteMediaFromPlaylistResponse ¶ added in v1.0.0
type DeleteMediaFromPlaylistResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Deleted media from playlist successfully
PlaylistByIDResponse *components.PlaylistByIDResponse
}
func (*DeleteMediaFromPlaylistResponse) GetHTTPMeta ¶ added in v1.0.0
func (d *DeleteMediaFromPlaylistResponse) GetHTTPMeta() components.HTTPMetadata
func (*DeleteMediaFromPlaylistResponse) GetPlaylistByIDResponse ¶ added in v1.0.0
func (d *DeleteMediaFromPlaylistResponse) GetPlaylistByIDResponse() *components.PlaylistByIDResponse
type DeleteMediaPlaybackIDRequest ¶
type DeleteMediaPlaybackIDRequest struct {
// Return the universal unique identifier for media which can contain a maximum of 255 characters.
MediaID string `pathParam:"style=simple,explode=false,name=mediaId"`
// Return the universal unique identifier for playbacks which can contain a maximum of 255 characters.
PlaybackID string `queryParam:"style=form,explode=true,name=playbackId"`
}
func (*DeleteMediaPlaybackIDRequest) GetMediaID ¶
func (d *DeleteMediaPlaybackIDRequest) GetMediaID() string
func (*DeleteMediaPlaybackIDRequest) GetPlaybackID ¶
func (d *DeleteMediaPlaybackIDRequest) GetPlaybackID() string
type DeleteMediaPlaybackIDResponse ¶
type DeleteMediaPlaybackIDResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Deleted a Playback Id successfully
Object *DeleteMediaPlaybackIDResponseBody
}
func (*DeleteMediaPlaybackIDResponse) GetHTTPMeta ¶
func (d *DeleteMediaPlaybackIDResponse) GetHTTPMeta() components.HTTPMetadata
func (*DeleteMediaPlaybackIDResponse) GetObject ¶
func (d *DeleteMediaPlaybackIDResponse) GetObject() *DeleteMediaPlaybackIDResponseBody
type DeleteMediaPlaybackIDResponseBody ¶
type DeleteMediaPlaybackIDResponseBody struct {
// Demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
}
DeleteMediaPlaybackIDResponseBody - Deleted a Playback Id successfully
func (*DeleteMediaPlaybackIDResponseBody) GetSuccess ¶
func (d *DeleteMediaPlaybackIDResponseBody) GetSuccess() *bool
type DeleteMediaRequest ¶
type DeleteMediaRequest struct {
// When creating the media, FastPix assigns a universally unique identifier with a maximum length of 255 characters.
MediaID string `pathParam:"style=simple,explode=false,name=mediaId"`
}
func (*DeleteMediaRequest) GetMediaID ¶
func (d *DeleteMediaRequest) GetMediaID() string
type DeleteMediaResponse ¶
type DeleteMediaResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Delete a video media
Object *DeleteMediaResponseBody
}
func (*DeleteMediaResponse) GetHTTPMeta ¶
func (d *DeleteMediaResponse) GetHTTPMeta() components.HTTPMetadata
func (*DeleteMediaResponse) GetObject ¶
func (d *DeleteMediaResponse) GetObject() *DeleteMediaResponseBody
type DeleteMediaResponseBody ¶
type DeleteMediaResponseBody struct {
// Demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
}
DeleteMediaResponseBody - Delete a video media
func (*DeleteMediaResponseBody) GetSuccess ¶
func (d *DeleteMediaResponseBody) GetSuccess() *bool
type DeleteMediaTrackRequest ¶ added in v1.0.0
type DeleteMediaTrackRequest struct {
// When creating the media, FastPix assigns a universally unique identifier with a maximum length of 255 characters.
MediaID string `pathParam:"style=simple,explode=false,name=mediaId"`
// When creating the media, FastPix assigns a universally unique identifier with a maximum length of 255 characters.
TrackID string `pathParam:"style=simple,explode=false,name=trackId"`
}
func (*DeleteMediaTrackRequest) GetMediaID ¶ added in v1.0.0
func (d *DeleteMediaTrackRequest) GetMediaID() string
func (*DeleteMediaTrackRequest) GetTrackID ¶ added in v1.0.0
func (d *DeleteMediaTrackRequest) GetTrackID() string
type DeleteMediaTrackResponse ¶ added in v1.0.0
type DeleteMediaTrackResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Delete a video media
Object *DeleteMediaTrackResponseBody
}
func (*DeleteMediaTrackResponse) GetHTTPMeta ¶ added in v1.0.0
func (d *DeleteMediaTrackResponse) GetHTTPMeta() components.HTTPMetadata
func (*DeleteMediaTrackResponse) GetObject ¶ added in v1.0.0
func (d *DeleteMediaTrackResponse) GetObject() *DeleteMediaTrackResponseBody
type DeleteMediaTrackResponseBody ¶ added in v1.0.0
type DeleteMediaTrackResponseBody struct {
// Demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
}
DeleteMediaTrackResponseBody - Delete a video media
func (*DeleteMediaTrackResponseBody) GetSuccess ¶ added in v1.0.0
func (d *DeleteMediaTrackResponseBody) GetSuccess() *bool
type DeletePlaybackIDOfStreamRequest ¶
type DeletePlaybackIDOfStreamRequest struct {
// Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
StreamID string `pathParam:"style=simple,explode=false,name=streamId"`
// Unique identifier for the playbackId
PlaybackID string `queryParam:"style=form,explode=true,name=playbackId"`
}
func (*DeletePlaybackIDOfStreamRequest) GetPlaybackID ¶
func (d *DeletePlaybackIDOfStreamRequest) GetPlaybackID() string
func (*DeletePlaybackIDOfStreamRequest) GetStreamID ¶
func (d *DeletePlaybackIDOfStreamRequest) GetStreamID() string
type DeletePlaybackIDOfStreamResponse ¶
type DeletePlaybackIDOfStreamResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Stream's playbackId deleted successfully
LiveStreamDeleteResponse *components.LiveStreamDeleteResponse
}
func (*DeletePlaybackIDOfStreamResponse) GetHTTPMeta ¶
func (d *DeletePlaybackIDOfStreamResponse) GetHTTPMeta() components.HTTPMetadata
func (*DeletePlaybackIDOfStreamResponse) GetLiveStreamDeleteResponse ¶
func (d *DeletePlaybackIDOfStreamResponse) GetLiveStreamDeleteResponse() *components.LiveStreamDeleteResponse
type DeleteSigningKeyRequest ¶ added in v1.0.0
type DeleteSigningKeyRequest struct {
// When creating the signing key, FastPix assigns a universally unique identifier with a maximum length of 255 characters.
SigningKeyID string `pathParam:"style=simple,explode=false,name=signingKeyId"`
}
func (*DeleteSigningKeyRequest) GetSigningKeyID ¶ added in v1.0.0
func (d *DeleteSigningKeyRequest) GetSigningKeyID() string
type DeleteSigningKeyResponse ¶ added in v1.0.0
type DeleteSigningKeyResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// successfully fetched all signing keys
DeleteSigningKeyResponse *components.DeleteSigningKeyResponse
}
func (*DeleteSigningKeyResponse) GetDeleteSigningKeyResponse ¶ added in v1.0.0
func (d *DeleteSigningKeyResponse) GetDeleteSigningKeyResponse() *components.DeleteSigningKeyResponse
func (*DeleteSigningKeyResponse) GetHTTPMeta ¶ added in v1.0.0
func (d *DeleteSigningKeyResponse) GetHTTPMeta() components.HTTPMetadata
type DeleteSimulcastOfStreamRequest ¶
type DeleteSimulcastOfStreamRequest struct {
// Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
StreamID string `pathParam:"style=simple,explode=false,name=streamId"`
// When you create the new simulcast, FastPix assign a universal unique identifier which can contain a maximum of 255 characters.
SimulcastID string `pathParam:"style=simple,explode=false,name=simulcastId"`
}
func (*DeleteSimulcastOfStreamRequest) GetSimulcastID ¶
func (d *DeleteSimulcastOfStreamRequest) GetSimulcastID() string
func (*DeleteSimulcastOfStreamRequest) GetStreamID ¶
func (d *DeleteSimulcastOfStreamRequest) GetStreamID() string
type DeleteSimulcastOfStreamResponse ¶
type DeleteSimulcastOfStreamResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Stream's simulcast deleted successfully
SimulcastdeleteResponse *components.SimulcastdeleteResponse
}
func (*DeleteSimulcastOfStreamResponse) GetHTTPMeta ¶
func (d *DeleteSimulcastOfStreamResponse) GetHTTPMeta() components.HTTPMetadata
func (*DeleteSimulcastOfStreamResponse) GetSimulcastdeleteResponse ¶
func (d *DeleteSimulcastOfStreamResponse) GetSimulcastdeleteResponse() *components.SimulcastdeleteResponse
type DimensionsID ¶ added in v1.0.0
type DimensionsID string
DimensionsID - Pass Dimensions id
const ( DimensionsIDBrowserName DimensionsID = "browser_name" DimensionsIDBrowserVersion DimensionsID = "browser_version" DimensionsIDOsName DimensionsID = "os_name" DimensionsIDOsVersion DimensionsID = "os_version" DimensionsIDDeviceName DimensionsID = "device_name" DimensionsIDDeviceModel DimensionsID = "device_model" DimensionsIDDeviceType DimensionsID = "device_type" DimensionsIDDeviceManufacturer DimensionsID = "device_manufacturer" DimensionsIDPlayerRemotePlayed DimensionsID = "player_remote_played" DimensionsIDPlayerName DimensionsID = "player_name" DimensionsIDPlayerVersion DimensionsID = "player_version" DimensionsIDPlayerSoftwareName DimensionsID = "player_software_name" DimensionsIDPlayerSoftwareVersion DimensionsID = "player_software_version" DimensionsIDPlayerResolution DimensionsID = "player_resolution" DimensionsIDFpSDK DimensionsID = "fp_sdk" DimensionsIDFpSDKVersion DimensionsID = "fp_sdk_version" DimensionsIDPlayerAutoplayOn DimensionsID = "player_autoplay_on" DimensionsIDPlayerPreloadOn DimensionsID = "player_preload_on" DimensionsIDVideoTitle DimensionsID = "video_title" DimensionsIDVideoID DimensionsID = "video_id" DimensionsIDVideoSeries DimensionsID = "video_series" DimensionsIDFpPlaybackID DimensionsID = "fp_playback_id" DimensionsIDFpLiveStreamID DimensionsID = "fp_live_stream_id" DimensionsIDMediaID DimensionsID = "media_id" DimensionsIDVideoSourceStreamType DimensionsID = "video_source_stream_type" DimensionsIDVideoSourceType DimensionsID = "video_source_type" DimensionsIDVideoEncodingVariant DimensionsID = "video_encoding_variant" DimensionsIDExperimentName DimensionsID = "experiment_name" DimensionsIDSubPropertyID DimensionsID = "sub_property_id" DimensionsIDDrmType DimensionsID = "drm_type" DimensionsIDAsnName DimensionsID = "asn_name" DimensionsIDCdn DimensionsID = "cdn" DimensionsIDVideoSourceHostname DimensionsID = "video_source_hostname" DimensionsIDConnectionType DimensionsID = "connection_type" DimensionsIDViewSessionID DimensionsID = "view_session_id" DimensionsIDContinent DimensionsID = "continent" DimensionsIDCountry DimensionsID = "country" DimensionsIDRegion DimensionsID = "region" DimensionsIDViewerID DimensionsID = "viewer_id" DimensionsIDErrorCode DimensionsID = "error_code" DimensionsIDExitBeforeVideoStart DimensionsID = "exit_before_video_start" DimensionsIDViewHasAd DimensionsID = "view_has_ad" DimensionsIDVideoStartupFailed DimensionsID = "video_startup_failed" DimensionsIDPageContext DimensionsID = "page_context" DimensionsIDPlaybackFailed DimensionsID = "playback_failed" DimensionsIDCustom1 DimensionsID = "custom_1" DimensionsIDCustom2 DimensionsID = "custom_2" DimensionsIDCustom3 DimensionsID = "custom_3" DimensionsIDCustom4 DimensionsID = "custom_4" DimensionsIDCustom5 DimensionsID = "custom_5" DimensionsIDCustom6 DimensionsID = "custom_6" DimensionsIDCustom7 DimensionsID = "custom_7" DimensionsIDCustom8 DimensionsID = "custom_8" DimensionsIDCustom9 DimensionsID = "custom_9" DimensionsIDCustom10 DimensionsID = "custom_10" )
func (DimensionsID) ToPointer ¶ added in v1.0.0
func (e DimensionsID) ToPointer() *DimensionsID
func (*DimensionsID) UnmarshalJSON ¶ added in v1.0.0
func (e *DimensionsID) UnmarshalJSON(data []byte) error
type DirectUploadVideoMediaAccessRestrictions ¶
type DirectUploadVideoMediaAccessRestrictions struct {
// Restrictions based on the originating domain of a request
Domains *components.DomainRestrictions `json:"domains,omitempty"`
// Restrictions based on the user agent
UserAgents *components.UserAgentRestrictions `json:"userAgents,omitempty"`
}
func (*DirectUploadVideoMediaAccessRestrictions) GetDomains ¶
func (d *DirectUploadVideoMediaAccessRestrictions) GetDomains() *components.DomainRestrictions
func (*DirectUploadVideoMediaAccessRestrictions) GetUserAgents ¶
func (d *DirectUploadVideoMediaAccessRestrictions) GetUserAgents() *components.UserAgentRestrictions
type DirectUploadVideoMediaModeration ¶ added in v1.0.0
type DirectUploadVideoMediaModeration struct {
// Type of media content
Type *components.MediaType `json:"type,omitempty"`
}
func (*DirectUploadVideoMediaModeration) GetType ¶ added in v1.0.0
func (d *DirectUploadVideoMediaModeration) GetType() *components.MediaType
type DirectUploadVideoMediaMp4Support ¶ added in v1.0.0
type DirectUploadVideoMediaMp4Support string
DirectUploadVideoMediaMp4Support - Generates MP4 video up to 4K ("capped_4k"), m4a audio only ("audioOnly"), or both for offline viewing.
const ( DirectUploadVideoMediaMp4SupportCapped4k DirectUploadVideoMediaMp4Support = "capped_4k" DirectUploadVideoMediaMp4SupportAudioOnly DirectUploadVideoMediaMp4Support = "audioOnly" DirectUploadVideoMediaMp4SupportAudioOnlyCapped4k DirectUploadVideoMediaMp4Support = "audioOnly,capped_4k" )
func (DirectUploadVideoMediaMp4Support) ToPointer ¶ added in v1.0.0
func (e DirectUploadVideoMediaMp4Support) ToPointer() *DirectUploadVideoMediaMp4Support
func (*DirectUploadVideoMediaMp4Support) UnmarshalJSON ¶ added in v1.0.0
func (e *DirectUploadVideoMediaMp4Support) UnmarshalJSON(data []byte) error
type DirectUploadVideoMediaRequest ¶
type DirectUploadVideoMediaRequest struct {
// Upload media directly from a device using the URL name or enter '*' to allow all.
CorsOrigin string `json:"corsOrigin"`
// Configuration settings for media upload.
PushMediaSettings *PushMediaSettings `json:"pushMediaSettings,omitempty"`
}
DirectUploadVideoMediaRequest - Request body for direct upload
func (*DirectUploadVideoMediaRequest) GetCorsOrigin ¶
func (d *DirectUploadVideoMediaRequest) GetCorsOrigin() string
func (*DirectUploadVideoMediaRequest) GetPushMediaSettings ¶
func (d *DirectUploadVideoMediaRequest) GetPushMediaSettings() *PushMediaSettings
type DirectUploadVideoMediaResponse ¶
type DirectUploadVideoMediaResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Direct upload created successfully
Object *DirectUploadVideoMediaResponseBody
}
func (*DirectUploadVideoMediaResponse) GetHTTPMeta ¶
func (d *DirectUploadVideoMediaResponse) GetHTTPMeta() components.HTTPMetadata
func (*DirectUploadVideoMediaResponse) GetObject ¶
func (d *DirectUploadVideoMediaResponse) GetObject() *DirectUploadVideoMediaResponseBody
type DirectUploadVideoMediaResponseBody ¶
type DirectUploadVideoMediaResponseBody struct {
// Demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
// Displays the result of the request.
Data *components.DirectUpload `json:"data,omitempty"`
}
DirectUploadVideoMediaResponseBody - Direct upload created successfully
func (*DirectUploadVideoMediaResponseBody) GetData ¶
func (d *DirectUploadVideoMediaResponseBody) GetData() *components.DirectUpload
func (*DirectUploadVideoMediaResponseBody) GetSuccess ¶
func (d *DirectUploadVideoMediaResponseBody) GetSuccess() *bool
type DisableLiveStreamRequest ¶ added in v1.0.0
type DisableLiveStreamRequest struct {
// Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
StreamID string `pathParam:"style=simple,explode=false,name=streamId"`
}
func (*DisableLiveStreamRequest) GetStreamID ¶ added in v1.0.0
func (d *DisableLiveStreamRequest) GetStreamID() string
type DisableLiveStreamResponse ¶ added in v1.0.0
type DisableLiveStreamResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Stream details updated successfully
LiveStreamDeleteResponse *components.LiveStreamDeleteResponse
}
func (*DisableLiveStreamResponse) GetHTTPMeta ¶ added in v1.0.0
func (d *DisableLiveStreamResponse) GetHTTPMeta() components.HTTPMetadata
func (*DisableLiveStreamResponse) GetLiveStreamDeleteResponse ¶ added in v1.0.0
func (d *DisableLiveStreamResponse) GetLiveStreamDeleteResponse() *components.LiveStreamDeleteResponse
type EnableLiveStreamRequest ¶ added in v1.0.0
type EnableLiveStreamRequest struct {
// Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
StreamID string `pathParam:"style=simple,explode=false,name=streamId"`
}
func (*EnableLiveStreamRequest) GetStreamID ¶ added in v1.0.0
func (e *EnableLiveStreamRequest) GetStreamID() string
type EnableLiveStreamResponse ¶ added in v1.0.0
type EnableLiveStreamResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Stream details updated successfully
LiveStreamDeleteResponse *components.LiveStreamDeleteResponse
}
func (*EnableLiveStreamResponse) GetHTTPMeta ¶ added in v1.0.0
func (e *EnableLiveStreamResponse) GetHTTPMeta() components.HTTPMetadata
func (*EnableLiveStreamResponse) GetLiveStreamDeleteResponse ¶ added in v1.0.0
func (e *EnableLiveStreamResponse) GetLiveStreamDeleteResponse() *components.LiveStreamDeleteResponse
type ErrorCode ¶ added in v1.0.0
type ErrorCode struct {
Str *string `queryParam:"inline,name=errorCode"`
Integer *int64 `queryParam:"inline,name=errorCode"`
Type ErrorCodeType
}
ErrorCode - Pass the error code to filter the list of views. The possible values of error code can be fetched from list of errors end point.
func CreateErrorCodeInteger ¶ added in v1.0.0
func CreateErrorCodeStr ¶ added in v1.0.0
func (ErrorCode) MarshalJSON ¶ added in v1.0.0
func (*ErrorCode) UnmarshalJSON ¶ added in v1.0.0
type ErrorCodeType ¶ added in v1.0.0
type ErrorCodeType string
const ( ErrorCodeTypeStr ErrorCodeType = "str" ErrorCodeTypeInteger ErrorCodeType = "integer" )
type GenerateSubtitleTrackRequest ¶ added in v1.0.0
type GenerateSubtitleTrackRequest struct {
// A universally unique identifier (UUID) assigned to the media by FastPix.
MediaID string `pathParam:"style=simple,explode=false,name=mediaId"`
// A universally unique identifier (UUID) assigned to the specific track for which subtitles should be generated.
TrackID string `pathParam:"style=simple,explode=false,name=trackId"`
TrackSubtitlesGenerateRequest components.TrackSubtitlesGenerateRequest `request:"mediaType=application/json"`
}
func (*GenerateSubtitleTrackRequest) GetMediaID ¶ added in v1.0.0
func (g *GenerateSubtitleTrackRequest) GetMediaID() string
func (*GenerateSubtitleTrackRequest) GetTrackID ¶ added in v1.0.0
func (g *GenerateSubtitleTrackRequest) GetTrackID() string
func (*GenerateSubtitleTrackRequest) GetTrackSubtitlesGenerateRequest ¶ added in v1.0.0
func (g *GenerateSubtitleTrackRequest) GetTrackSubtitlesGenerateRequest() components.TrackSubtitlesGenerateRequest
type GenerateSubtitleTrackResponse ¶ added in v1.0.0
type GenerateSubtitleTrackResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Media details updated successfully
Object *GenerateSubtitleTrackResponseBody
}
func (*GenerateSubtitleTrackResponse) GetHTTPMeta ¶ added in v1.0.0
func (g *GenerateSubtitleTrackResponse) GetHTTPMeta() components.HTTPMetadata
func (*GenerateSubtitleTrackResponse) GetObject ¶ added in v1.0.0
func (g *GenerateSubtitleTrackResponse) GetObject() *GenerateSubtitleTrackResponseBody
type GenerateSubtitleTrackResponseBody ¶ added in v1.0.0
type GenerateSubtitleTrackResponseBody struct {
// Demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
// Represents the response for a successfully generated subtitle track.
Data *components.GenerateTrackResponse `json:"data,omitempty"`
}
GenerateSubtitleTrackResponseBody - Media details updated successfully
func (*GenerateSubtitleTrackResponseBody) GetData ¶ added in v1.0.0
func (g *GenerateSubtitleTrackResponseBody) GetData() *components.GenerateTrackResponse
func (*GenerateSubtitleTrackResponseBody) GetSuccess ¶ added in v1.0.0
func (g *GenerateSubtitleTrackResponseBody) GetSuccess() *bool
type GetAllPlaylistsRequest ¶ added in v1.0.0
type GetAllPlaylistsRequest struct {
// The number of playlists to return (default is 10, max is 50).
Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
// The page number to retrieve, starting from 1. Used for paginating the playlist results.
Offset *int64 `default:"1" queryParam:"style=form,explode=true,name=offset"`
}
func (*GetAllPlaylistsRequest) GetLimit ¶ added in v1.0.0
func (g *GetAllPlaylistsRequest) GetLimit() *int64
func (*GetAllPlaylistsRequest) GetOffset ¶ added in v1.0.0
func (g *GetAllPlaylistsRequest) GetOffset() *int64
func (GetAllPlaylistsRequest) MarshalJSON ¶ added in v1.0.0
func (g GetAllPlaylistsRequest) MarshalJSON() ([]byte, error)
func (*GetAllPlaylistsRequest) UnmarshalJSON ¶ added in v1.0.0
func (g *GetAllPlaylistsRequest) UnmarshalJSON(data []byte) error
type GetAllPlaylistsResponse ¶ added in v1.0.0
type GetAllPlaylistsResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Successfully retrieved all playlists
GetAllPlaylistsResponse *components.GetAllPlaylistsResponse
}
func (*GetAllPlaylistsResponse) GetGetAllPlaylistsResponse ¶ added in v1.0.0
func (g *GetAllPlaylistsResponse) GetGetAllPlaylistsResponse() *components.GetAllPlaylistsResponse
func (*GetAllPlaylistsResponse) GetHTTPMeta ¶ added in v1.0.0
func (g *GetAllPlaylistsResponse) GetHTTPMeta() components.HTTPMetadata
type GetAllStreamsRequest ¶
type GetAllStreamsRequest struct {
// Limit specifies the maximum number of items to display per page.
Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
// Offset determines the starting point for data retrieval within a paginated list.
Offset *int64 `default:"1" queryParam:"style=form,explode=true,name=offset"`
// The list of value can be order in two ways DESC (Descending) or ASC (Ascending). In case not specified, by default it will be DESC.
OrderBy *OrderBy `default:"desc" queryParam:"style=form,explode=true,name=orderBy"`
}
func (*GetAllStreamsRequest) GetLimit ¶
func (g *GetAllStreamsRequest) GetLimit() *int64
func (*GetAllStreamsRequest) GetOffset ¶
func (g *GetAllStreamsRequest) GetOffset() *int64
func (*GetAllStreamsRequest) GetOrderBy ¶
func (g *GetAllStreamsRequest) GetOrderBy() *OrderBy
func (GetAllStreamsRequest) MarshalJSON ¶
func (g GetAllStreamsRequest) MarshalJSON() ([]byte, error)
func (*GetAllStreamsRequest) UnmarshalJSON ¶
func (g *GetAllStreamsRequest) UnmarshalJSON(data []byte) error
type GetAllStreamsResponse ¶
type GetAllStreamsResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// All streams retrieved sucessfully
GetStreamsResponse *components.GetStreamsResponse
}
func (*GetAllStreamsResponse) GetGetStreamsResponse ¶
func (g *GetAllStreamsResponse) GetGetStreamsResponse() *components.GetStreamsResponse
func (*GetAllStreamsResponse) GetHTTPMeta ¶
func (g *GetAllStreamsResponse) GetHTTPMeta() components.HTTPMetadata
type GetDataViewlistCurrentViewsFilterData ¶ added in v1.0.0
type GetDataViewlistCurrentViewsFilterData struct {
// Number of concurrent viewers for this dimension value.
ConcurrentViewers *int64 `json:"concurrent_viewers,omitempty"`
// Name of the dimension (e.g., country, device type, etc.).
DimensionName *string `json:"dimension_name,omitempty"`
// Additional metric value for this dimension (if applicable).
MetricValue *int64 `json:"metricValue,omitempty"`
}
func (*GetDataViewlistCurrentViewsFilterData) GetConcurrentViewers ¶ added in v1.0.0
func (g *GetDataViewlistCurrentViewsFilterData) GetConcurrentViewers() *int64
func (*GetDataViewlistCurrentViewsFilterData) GetDimensionName ¶ added in v1.0.0
func (g *GetDataViewlistCurrentViewsFilterData) GetDimensionName() *string
func (*GetDataViewlistCurrentViewsFilterData) GetMetricValue ¶ added in v1.0.0
func (g *GetDataViewlistCurrentViewsFilterData) GetMetricValue() *int64
type GetDataViewlistCurrentViewsFilterDimension ¶ added in v1.0.0
type GetDataViewlistCurrentViewsFilterDimension string
GetDataViewlistCurrentViewsFilterDimension - The dimension to group and breakdown the concurrent viewers data by. This determines how the results will be categorized and aggregated. Choose from geographic, content, technical, or behavioral dimensions.
const ( GetDataViewlistCurrentViewsFilterDimensionCountry GetDataViewlistCurrentViewsFilterDimension = "country" GetDataViewlistCurrentViewsFilterDimensionRegion GetDataViewlistCurrentViewsFilterDimension = "region" GetDataViewlistCurrentViewsFilterDimensionAsnID GetDataViewlistCurrentViewsFilterDimension = "asn_id" GetDataViewlistCurrentViewsFilterDimensionCdn GetDataViewlistCurrentViewsFilterDimension = "cdn" GetDataViewlistCurrentViewsFilterDimensionVideoTitle GetDataViewlistCurrentViewsFilterDimension = "video_title" GetDataViewlistCurrentViewsFilterDimensionVideoSeries GetDataViewlistCurrentViewsFilterDimension = "video_series" GetDataViewlistCurrentViewsFilterDimensionVideoID GetDataViewlistCurrentViewsFilterDimension = "video_id" GetDataViewlistCurrentViewsFilterDimensionSubPropertyID GetDataViewlistCurrentViewsFilterDimension = "sub_property_id" GetDataViewlistCurrentViewsFilterDimensionVideoSourceStreamType GetDataViewlistCurrentViewsFilterDimension = "video_source_stream_type" GetDataViewlistCurrentViewsFilterDimensionOsName GetDataViewlistCurrentViewsFilterDimension = "os_name" GetDataViewlistCurrentViewsFilterDimensionPlayerName GetDataViewlistCurrentViewsFilterDimension = "player_name" GetDataViewlistCurrentViewsFilterDimensionMediaID GetDataViewlistCurrentViewsFilterDimension = "media_id" GetDataViewlistCurrentViewsFilterDimensionFpPlaybackID GetDataViewlistCurrentViewsFilterDimension = "fp_playback_id" GetDataViewlistCurrentViewsFilterDimensionViewID GetDataViewlistCurrentViewsFilterDimension = "view_id" )
func (GetDataViewlistCurrentViewsFilterDimension) ToPointer ¶ added in v1.0.0
func (e GetDataViewlistCurrentViewsFilterDimension) ToPointer() *GetDataViewlistCurrentViewsFilterDimension
func (*GetDataViewlistCurrentViewsFilterDimension) UnmarshalJSON ¶ added in v1.0.0
func (e *GetDataViewlistCurrentViewsFilterDimension) UnmarshalJSON(data []byte) error
type GetDataViewlistCurrentViewsFilterRequest ¶ added in v1.0.0
type GetDataViewlistCurrentViewsFilterRequest struct {
// The dimension to group and breakdown the concurrent viewers data by.
// This determines how the results will be categorized and aggregated.
// Choose from geographic, content, technical, or behavioral dimensions.
//
Dimension *GetDataViewlistCurrentViewsFilterDimension `queryParam:"style=form,explode=true,name=dimension"`
// Maximum number of results to return. Controls the number of dimension values
// that will be included in the response. Useful for pagination and performance.
// Higher limits provide more detailed breakdowns but may impact response time.
//
Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
}
func (*GetDataViewlistCurrentViewsFilterRequest) GetDimension ¶ added in v1.0.0
func (g *GetDataViewlistCurrentViewsFilterRequest) GetDimension() *GetDataViewlistCurrentViewsFilterDimension
func (*GetDataViewlistCurrentViewsFilterRequest) GetLimit ¶ added in v1.0.0
func (g *GetDataViewlistCurrentViewsFilterRequest) GetLimit() *int64
func (GetDataViewlistCurrentViewsFilterRequest) MarshalJSON ¶ added in v1.0.0
func (g GetDataViewlistCurrentViewsFilterRequest) MarshalJSON() ([]byte, error)
func (*GetDataViewlistCurrentViewsFilterRequest) UnmarshalJSON ¶ added in v1.0.0
func (g *GetDataViewlistCurrentViewsFilterRequest) UnmarshalJSON(data []byte) error
type GetDataViewlistCurrentViewsFilterResponse ¶ added in v1.0.0
type GetDataViewlistCurrentViewsFilterResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Successfully retrieved concurrent viewers breakdown by the specified dimension.
Object *GetDataViewlistCurrentViewsFilterResponseBody
}
func (*GetDataViewlistCurrentViewsFilterResponse) GetHTTPMeta ¶ added in v1.0.0
func (g *GetDataViewlistCurrentViewsFilterResponse) GetHTTPMeta() components.HTTPMetadata
func (*GetDataViewlistCurrentViewsFilterResponse) GetObject ¶ added in v1.0.0
func (g *GetDataViewlistCurrentViewsFilterResponse) GetObject() *GetDataViewlistCurrentViewsFilterResponseBody
type GetDataViewlistCurrentViewsFilterResponseBody ¶ added in v1.0.0
type GetDataViewlistCurrentViewsFilterResponseBody struct {
// Indicates if the request was successful.
Success *bool `json:"success,omitempty"`
// Breakdown of concurrent viewers by the specified dimension.
Data []GetDataViewlistCurrentViewsFilterData `json:"data,omitempty"`
// Start and end epoch timestamps (milliseconds) for the timespan window.
Timespan []int64 `json:"timespan,omitempty"`
}
GetDataViewlistCurrentViewsFilterResponseBody - Successfully retrieved concurrent viewers breakdown by the specified dimension.
func (*GetDataViewlistCurrentViewsFilterResponseBody) GetData ¶ added in v1.0.0
func (g *GetDataViewlistCurrentViewsFilterResponseBody) GetData() []GetDataViewlistCurrentViewsFilterData
func (*GetDataViewlistCurrentViewsFilterResponseBody) GetSuccess ¶ added in v1.0.0
func (g *GetDataViewlistCurrentViewsFilterResponseBody) GetSuccess() *bool
func (*GetDataViewlistCurrentViewsFilterResponseBody) GetTimespan ¶ added in v1.0.0
func (g *GetDataViewlistCurrentViewsFilterResponseBody) GetTimespan() []int64
type GetDataViewlistCurrentViewsGetTimeseriesViewsData ¶ added in v1.0.0
type GetDataViewlistCurrentViewsGetTimeseriesViewsData struct {
// The timestamp for the interval (ISO 8601 format).
IntervalTime *time.Time `json:"intervalTime,omitempty"`
// Reserved for future metric values (currently null).
MetricValue optionalnullable.OptionalNullable[int64] `json:"metricValue,omitempty"`
// Number of concurrent viewers at the given interval.
NumberOfViews *int64 `json:"numberOfViews,omitempty"`
}
func (*GetDataViewlistCurrentViewsGetTimeseriesViewsData) GetIntervalTime ¶ added in v1.0.0
func (g *GetDataViewlistCurrentViewsGetTimeseriesViewsData) GetIntervalTime() *time.Time
func (*GetDataViewlistCurrentViewsGetTimeseriesViewsData) GetMetricValue ¶ added in v1.0.0
func (g *GetDataViewlistCurrentViewsGetTimeseriesViewsData) GetMetricValue() optionalnullable.OptionalNullable[int64]
func (*GetDataViewlistCurrentViewsGetTimeseriesViewsData) GetNumberOfViews ¶ added in v1.0.0
func (g *GetDataViewlistCurrentViewsGetTimeseriesViewsData) GetNumberOfViews() *int64
func (GetDataViewlistCurrentViewsGetTimeseriesViewsData) MarshalJSON ¶ added in v1.0.0
func (g GetDataViewlistCurrentViewsGetTimeseriesViewsData) MarshalJSON() ([]byte, error)
func (*GetDataViewlistCurrentViewsGetTimeseriesViewsData) UnmarshalJSON ¶ added in v1.0.0
func (g *GetDataViewlistCurrentViewsGetTimeseriesViewsData) UnmarshalJSON(data []byte) error
type GetDataViewlistCurrentViewsGetTimeseriesViewsResponse ¶ added in v1.0.0
type GetDataViewlistCurrentViewsGetTimeseriesViewsResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Successfully retrieved concurrent viewers timeseries.
Object *GetDataViewlistCurrentViewsGetTimeseriesViewsResponseBody
}
func (*GetDataViewlistCurrentViewsGetTimeseriesViewsResponse) GetHTTPMeta ¶ added in v1.0.0
func (g *GetDataViewlistCurrentViewsGetTimeseriesViewsResponse) GetHTTPMeta() components.HTTPMetadata
type GetDataViewlistCurrentViewsGetTimeseriesViewsResponseBody ¶ added in v1.0.0
type GetDataViewlistCurrentViewsGetTimeseriesViewsResponseBody struct {
// Indicates if the request was successful.
Success *bool `json:"success,omitempty"`
// Time series data for concurrent viewers.
Data []GetDataViewlistCurrentViewsGetTimeseriesViewsData `json:"data,omitempty"`
// Start and end epoch timestamps (milliseconds) for the timeseries window.
Timespan []int64 `json:"timespan,omitempty"`
}
GetDataViewlistCurrentViewsGetTimeseriesViewsResponseBody - Successfully retrieved concurrent viewers timeseries.
func (*GetDataViewlistCurrentViewsGetTimeseriesViewsResponseBody) GetSuccess ¶ added in v1.0.0
func (g *GetDataViewlistCurrentViewsGetTimeseriesViewsResponseBody) GetSuccess() *bool
func (*GetDataViewlistCurrentViewsGetTimeseriesViewsResponseBody) GetTimespan ¶ added in v1.0.0
func (g *GetDataViewlistCurrentViewsGetTimeseriesViewsResponseBody) GetTimespan() []int64
type GetDrmConfigurationByIDRequest ¶ added in v1.0.0
type GetDrmConfigurationByIDRequest struct {
// The unique identifier of the DRM configuration.
DrmConfigurationID string `pathParam:"style=simple,explode=false,name=drmConfigurationId"`
}
func (*GetDrmConfigurationByIDRequest) GetDrmConfigurationID ¶ added in v1.0.0
func (g *GetDrmConfigurationByIDRequest) GetDrmConfigurationID() string
type GetDrmConfigurationByIDResponse ¶ added in v1.0.0
type GetDrmConfigurationByIDResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// DRM configuration retrieved successfully
Object *GetDrmConfigurationByIDResponseBody
}
func (*GetDrmConfigurationByIDResponse) GetHTTPMeta ¶ added in v1.0.0
func (g *GetDrmConfigurationByIDResponse) GetHTTPMeta() components.HTTPMetadata
func (*GetDrmConfigurationByIDResponse) GetObject ¶ added in v1.0.0
func (g *GetDrmConfigurationByIDResponse) GetObject() *GetDrmConfigurationByIDResponseBody
type GetDrmConfigurationByIDResponseBody ¶ added in v1.0.0
type GetDrmConfigurationByIDResponseBody struct {
Success *bool `json:"success,omitempty"`
Data *components.DrmIDResponse `json:"data,omitempty"`
}
GetDrmConfigurationByIDResponseBody - DRM configuration retrieved successfully
func (*GetDrmConfigurationByIDResponseBody) GetData ¶ added in v1.0.0
func (g *GetDrmConfigurationByIDResponseBody) GetData() *components.DrmIDResponse
func (*GetDrmConfigurationByIDResponseBody) GetSuccess ¶ added in v1.0.0
func (g *GetDrmConfigurationByIDResponseBody) GetSuccess() *bool
type GetDrmConfigurationRequest ¶ added in v1.0.0
type GetDrmConfigurationRequest struct {
// Offset determines the starting point for data retrieval within a paginated list.
Offset *int64 `default:"1" queryParam:"style=form,explode=true,name=offset"`
// Limit specifies the maximum number of items to display per page.
Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
}
func (*GetDrmConfigurationRequest) GetLimit ¶ added in v1.0.0
func (g *GetDrmConfigurationRequest) GetLimit() *int64
func (*GetDrmConfigurationRequest) GetOffset ¶ added in v1.0.0
func (g *GetDrmConfigurationRequest) GetOffset() *int64
func (GetDrmConfigurationRequest) MarshalJSON ¶ added in v1.0.0
func (g GetDrmConfigurationRequest) MarshalJSON() ([]byte, error)
func (*GetDrmConfigurationRequest) UnmarshalJSON ¶ added in v1.0.0
func (g *GetDrmConfigurationRequest) UnmarshalJSON(data []byte) error
type GetDrmConfigurationResponse ¶ added in v1.0.0
type GetDrmConfigurationResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// DRM configuration(s) retrieved successfully
Object *GetDrmConfigurationResponseBody
}
func (*GetDrmConfigurationResponse) GetHTTPMeta ¶ added in v1.0.0
func (g *GetDrmConfigurationResponse) GetHTTPMeta() components.HTTPMetadata
func (*GetDrmConfigurationResponse) GetObject ¶ added in v1.0.0
func (g *GetDrmConfigurationResponse) GetObject() *GetDrmConfigurationResponseBody
type GetDrmConfigurationResponseBody ¶ added in v1.0.0
type GetDrmConfigurationResponseBody struct {
Success *bool `json:"success,omitempty"`
Data []components.DrmIDResponse `json:"data,omitempty"`
// Pagination organizes content into pages for better readability and navigation.
Pagination *components.Pagination `json:"pagination,omitempty"`
}
GetDrmConfigurationResponseBody - DRM configuration(s) retrieved successfully
func (*GetDrmConfigurationResponseBody) GetData ¶ added in v1.0.0
func (g *GetDrmConfigurationResponseBody) GetData() []components.DrmIDResponse
func (*GetDrmConfigurationResponseBody) GetPagination ¶ added in v1.0.0
func (g *GetDrmConfigurationResponseBody) GetPagination() *components.Pagination
func (*GetDrmConfigurationResponseBody) GetSuccess ¶ added in v1.0.0
func (g *GetDrmConfigurationResponseBody) GetSuccess() *bool
type GetLiveStreamByIDRequest ¶
type GetLiveStreamByIDRequest struct {
// Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
StreamID string `pathParam:"style=simple,explode=false,name=streamId"`
}
func (*GetLiveStreamByIDRequest) GetStreamID ¶
func (g *GetLiveStreamByIDRequest) GetStreamID() string
type GetLiveStreamByIDResponse ¶
type GetLiveStreamByIDResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Stream details retrieved successfully
LivestreamgetResponse *components.LivestreamgetResponse
}
func (*GetLiveStreamByIDResponse) GetHTTPMeta ¶
func (g *GetLiveStreamByIDResponse) GetHTTPMeta() components.HTTPMetadata
func (*GetLiveStreamByIDResponse) GetLivestreamgetResponse ¶
func (g *GetLiveStreamByIDResponse) GetLivestreamgetResponse() *components.LivestreamgetResponse
type GetLiveStreamPlaybackIDRequest ¶
type GetLiveStreamPlaybackIDRequest struct {
// Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
StreamID string `pathParam:"style=simple,explode=false,name=streamId"`
// Upon creating a new playbackId, FastPix assigns a unique identifier to the playback.
PlaybackID string `pathParam:"style=simple,explode=false,name=playbackId"`
}
func (*GetLiveStreamPlaybackIDRequest) GetPlaybackID ¶
func (g *GetLiveStreamPlaybackIDRequest) GetPlaybackID() string
func (*GetLiveStreamPlaybackIDRequest) GetStreamID ¶
func (g *GetLiveStreamPlaybackIDRequest) GetStreamID() string
type GetLiveStreamPlaybackIDResponse ¶
type GetLiveStreamPlaybackIDResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Stream details retrieved successfully
PlaybackIDSuccessResponse *components.PlaybackIDSuccessResponse
}
func (*GetLiveStreamPlaybackIDResponse) GetHTTPMeta ¶
func (g *GetLiveStreamPlaybackIDResponse) GetHTTPMeta() components.HTTPMetadata
func (*GetLiveStreamPlaybackIDResponse) GetPlaybackIDSuccessResponse ¶ added in v1.0.0
func (g *GetLiveStreamPlaybackIDResponse) GetPlaybackIDSuccessResponse() *components.PlaybackIDSuccessResponse
type GetLiveStreamViewerCountByIDRequest ¶ added in v1.0.0
type GetLiveStreamViewerCountByIDRequest struct {
// Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
StreamID string `pathParam:"style=simple,explode=false,name=streamId"`
}
func (*GetLiveStreamViewerCountByIDRequest) GetStreamID ¶ added in v1.0.0
func (g *GetLiveStreamViewerCountByIDRequest) GetStreamID() string
type GetLiveStreamViewerCountByIDResponse ¶ added in v1.0.0
type GetLiveStreamViewerCountByIDResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Stream viewer count retrieved successfully
ViewsCountResponse *components.ViewsCountResponse
}
func (*GetLiveStreamViewerCountByIDResponse) GetHTTPMeta ¶ added in v1.0.0
func (g *GetLiveStreamViewerCountByIDResponse) GetHTTPMeta() components.HTTPMetadata
func (*GetLiveStreamViewerCountByIDResponse) GetViewsCountResponse ¶ added in v1.0.0
func (g *GetLiveStreamViewerCountByIDResponse) GetViewsCountResponse() *components.ViewsCountResponse
type GetMediaClipsRequest ¶ added in v1.0.0
type GetMediaClipsRequest struct {
// The unique identifier of the source media.
SourceMediaID string `pathParam:"style=simple,explode=false,name=sourceMediaId"`
// Offset determines the starting point for data retrieval within a paginated list.
Offset *int64 `default:"1" queryParam:"style=form,explode=true,name=offset"`
// The number of media clips to retrieve per request.
Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
// The values in the list can be arranged in two ways DESC (Descending) or ASC (Ascending).
OrderBy *components.SortOrder `default:"desc" queryParam:"style=form,explode=true,name=orderBy"`
}
func (*GetMediaClipsRequest) GetLimit ¶ added in v1.0.0
func (g *GetMediaClipsRequest) GetLimit() *int64
func (*GetMediaClipsRequest) GetOffset ¶ added in v1.0.0
func (g *GetMediaClipsRequest) GetOffset() *int64
func (*GetMediaClipsRequest) GetOrderBy ¶ added in v1.0.0
func (g *GetMediaClipsRequest) GetOrderBy() *components.SortOrder
func (*GetMediaClipsRequest) GetSourceMediaID ¶ added in v1.0.0
func (g *GetMediaClipsRequest) GetSourceMediaID() string
func (GetMediaClipsRequest) MarshalJSON ¶ added in v1.0.0
func (g GetMediaClipsRequest) MarshalJSON() ([]byte, error)
func (*GetMediaClipsRequest) UnmarshalJSON ¶ added in v1.0.0
func (g *GetMediaClipsRequest) UnmarshalJSON(data []byte) error
type GetMediaClipsResponse ¶ added in v1.0.0
type GetMediaClipsResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Get media clips
MediaClipResponse *components.MediaClipResponse
}
func (*GetMediaClipsResponse) GetHTTPMeta ¶ added in v1.0.0
func (g *GetMediaClipsResponse) GetHTTPMeta() components.HTTPMetadata
func (*GetMediaClipsResponse) GetMediaClipResponse ¶ added in v1.0.0
func (g *GetMediaClipsResponse) GetMediaClipResponse() *components.MediaClipResponse
type GetMediaRequest ¶
type GetMediaRequest struct {
// The Media Id is assigned a universal unique identifier, which can contain a maximum of 255 characters.
MediaID string `pathParam:"style=simple,explode=false,name=mediaId"`
}
func (*GetMediaRequest) GetMediaID ¶
func (g *GetMediaRequest) GetMediaID() string
type GetMediaResponse ¶
type GetMediaResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Get a video media by id
Object *GetMediaResponseBody
}
func (*GetMediaResponse) GetHTTPMeta ¶
func (g *GetMediaResponse) GetHTTPMeta() components.HTTPMetadata
func (*GetMediaResponse) GetObject ¶
func (g *GetMediaResponse) GetObject() *GetMediaResponseBody
type GetMediaResponseBody ¶
type GetMediaResponseBody struct {
// Demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
Data *components.Media `json:"data,omitempty"`
}
GetMediaResponseBody - Get a video media by id
func (*GetMediaResponseBody) GetData ¶
func (g *GetMediaResponseBody) GetData() *components.Media
func (*GetMediaResponseBody) GetSuccess ¶
func (g *GetMediaResponseBody) GetSuccess() *bool
type GetPlaybackIDData ¶ added in v1.0.0
type GetPlaybackIDData struct {
// The unique identifier for the playback ID.
ID *string `json:"id,omitempty"`
// Access policy for media content
AccessPolicy *components.AccessPolicy `json:"accessPolicy,omitempty"`
}
func (*GetPlaybackIDData) GetAccessPolicy ¶ added in v1.0.0
func (g *GetPlaybackIDData) GetAccessPolicy() *components.AccessPolicy
func (*GetPlaybackIDData) GetID ¶ added in v1.0.0
func (g *GetPlaybackIDData) GetID() *string
type GetPlaybackIDRequest ¶ added in v1.0.0
type GetPlaybackIDRequest struct {
MediaID string `pathParam:"style=simple,explode=false,name=mediaId"`
PlaybackID string `pathParam:"style=simple,explode=false,name=playbackId"`
}
func (*GetPlaybackIDRequest) GetMediaID ¶ added in v1.0.0
func (g *GetPlaybackIDRequest) GetMediaID() string
func (*GetPlaybackIDRequest) GetPlaybackID ¶ added in v1.0.0
func (g *GetPlaybackIDRequest) GetPlaybackID() string
type GetPlaybackIDResponse ¶ added in v1.0.0
type GetPlaybackIDResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Successfully retrieved playback ID details
Object *GetPlaybackIDResponseBody
}
func (*GetPlaybackIDResponse) GetHTTPMeta ¶ added in v1.0.0
func (g *GetPlaybackIDResponse) GetHTTPMeta() components.HTTPMetadata
func (*GetPlaybackIDResponse) GetObject ¶ added in v1.0.0
func (g *GetPlaybackIDResponse) GetObject() *GetPlaybackIDResponseBody
type GetPlaybackIDResponseBody ¶ added in v1.0.0
type GetPlaybackIDResponseBody struct {
// Indicates if the request was successful or not.
Success *bool `json:"success,omitempty"`
Data *GetPlaybackIDData `json:"data,omitempty"`
}
GetPlaybackIDResponseBody - Successfully retrieved playback ID details
func (*GetPlaybackIDResponseBody) GetData ¶ added in v1.0.0
func (g *GetPlaybackIDResponseBody) GetData() *GetPlaybackIDData
func (*GetPlaybackIDResponseBody) GetSuccess ¶ added in v1.0.0
func (g *GetPlaybackIDResponseBody) GetSuccess() *bool
type GetPlaylistByIDRequest ¶ added in v1.0.0
type GetPlaylistByIDRequest struct {
// The unique id of the playlist you want to retrieve.
PlaylistID string `pathParam:"style=simple,explode=false,name=playlistId"`
}
func (*GetPlaylistByIDRequest) GetPlaylistID ¶ added in v1.0.0
func (g *GetPlaylistByIDRequest) GetPlaylistID() string
type GetPlaylistByIDResponse ¶ added in v1.0.0
type GetPlaylistByIDResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Successfully retrieved all playlists
PlaylistByIDResponse *components.PlaylistByIDResponse
}
func (*GetPlaylistByIDResponse) GetHTTPMeta ¶ added in v1.0.0
func (g *GetPlaylistByIDResponse) GetHTTPMeta() components.HTTPMetadata
func (*GetPlaylistByIDResponse) GetPlaylistByIDResponse ¶ added in v1.0.0
func (g *GetPlaylistByIDResponse) GetPlaylistByIDResponse() *components.PlaylistByIDResponse
type GetSigningKeyByIDRequest ¶ added in v1.0.0
type GetSigningKeyByIDRequest struct {
// When creating the signing key, FastPix assigns a universally unique identifier with a maximum length of 255 characters.
SigningKeyID string `pathParam:"style=simple,explode=false,name=signingKeyId"`
}
func (*GetSigningKeyByIDRequest) GetSigningKeyID ¶ added in v1.0.0
func (g *GetSigningKeyByIDRequest) GetSigningKeyID() string
type GetSigningKeyByIDResponse ¶ added in v1.0.0
type GetSigningKeyByIDResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// successfully fetched signing key
GetPublicPemUsingSigningKeyIDResponseDTO *components.GetPublicPemUsingSigningKeyIDResponseDTO
}
func (*GetSigningKeyByIDResponse) GetGetPublicPemUsingSigningKeyIDResponseDTO ¶ added in v1.0.0
func (g *GetSigningKeyByIDResponse) GetGetPublicPemUsingSigningKeyIDResponseDTO() *components.GetPublicPemUsingSigningKeyIDResponseDTO
func (*GetSigningKeyByIDResponse) GetHTTPMeta ¶ added in v1.0.0
func (g *GetSigningKeyByIDResponse) GetHTTPMeta() components.HTTPMetadata
type GetSpecificSimulcastOfStreamRequest ¶
type GetSpecificSimulcastOfStreamRequest struct {
// Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
StreamID string `pathParam:"style=simple,explode=false,name=streamId"`
// When you create the new simulcast, FastPix assign a universal unique identifier which can contain a maximum of 255 characters.
SimulcastID string `pathParam:"style=simple,explode=false,name=simulcastId"`
}
func (*GetSpecificSimulcastOfStreamRequest) GetSimulcastID ¶
func (g *GetSpecificSimulcastOfStreamRequest) GetSimulcastID() string
func (*GetSpecificSimulcastOfStreamRequest) GetStreamID ¶
func (g *GetSpecificSimulcastOfStreamRequest) GetStreamID() string
type GetSpecificSimulcastOfStreamResponse ¶
type GetSpecificSimulcastOfStreamResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Stream's simulcast details fetched successfully
SimulcastResponse *components.SimulcastResponse
}
func (*GetSpecificSimulcastOfStreamResponse) GetHTTPMeta ¶
func (g *GetSpecificSimulcastOfStreamResponse) GetHTTPMeta() components.HTTPMetadata
func (*GetSpecificSimulcastOfStreamResponse) GetSimulcastResponse ¶
func (g *GetSpecificSimulcastOfStreamResponse) GetSimulcastResponse() *components.SimulcastResponse
type GetTimeseriesDataMetricID ¶ added in v1.0.0
type GetTimeseriesDataMetricID string
GetTimeseriesDataMetricID - Pass metric Id
const ( GetTimeseriesDataMetricIDViews GetTimeseriesDataMetricID = "views" GetTimeseriesDataMetricIDUniqueViewers GetTimeseriesDataMetricID = "unique_viewers" GetTimeseriesDataMetricIDPlayingTime GetTimeseriesDataMetricID = "playing_time" GetTimeseriesDataMetricIDQualityOfExperienceScore GetTimeseriesDataMetricID = "quality_of_experience_score" GetTimeseriesDataMetricIDPlaybackScore GetTimeseriesDataMetricID = "playback_score" GetTimeseriesDataMetricIDPlaybackFailurePercentage GetTimeseriesDataMetricID = "playback_failure_percentage" GetTimeseriesDataMetricIDExitBeforeVideoStart GetTimeseriesDataMetricID = "exit_before_video_start" GetTimeseriesDataMetricIDVideoStartupFailurePercentage GetTimeseriesDataMetricID = "video_startup_failure_percentage" GetTimeseriesDataMetricIDStartupScore GetTimeseriesDataMetricID = "startup_score" GetTimeseriesDataMetricIDVideoStartupTime GetTimeseriesDataMetricID = "video_startup_time" GetTimeseriesDataMetricIDPlayerStartupTime GetTimeseriesDataMetricID = "player_startup_time" GetTimeseriesDataMetricIDPageLoadTime GetTimeseriesDataMetricID = "page_load_time" GetTimeseriesDataMetricIDTotalStartupTime GetTimeseriesDataMetricID = "total_startup_time" GetTimeseriesDataMetricIDLiveStreamLatency GetTimeseriesDataMetricID = "live_stream_latency" GetTimeseriesDataMetricIDAverageBitrate GetTimeseriesDataMetricID = "average_bitrate" GetTimeseriesDataMetricIDBufferCount GetTimeseriesDataMetricID = "buffer_count" GetTimeseriesDataMetricIDRenderQualityScore GetTimeseriesDataMetricID = "render_quality_score" GetTimeseriesDataMetricIDAvgUpscaling GetTimeseriesDataMetricID = "avg_upscaling" GetTimeseriesDataMetricIDAvgDownscaling GetTimeseriesDataMetricID = "avg_downscaling" GetTimeseriesDataMetricIDMaxUpscaling GetTimeseriesDataMetricID = "max_upscaling" GetTimeseriesDataMetricIDMaxDownscaling GetTimeseriesDataMetricID = "max_downscaling" GetTimeseriesDataMetricIDJumpLatency GetTimeseriesDataMetricID = "jump_latency" GetTimeseriesDataMetricIDStabilityScore GetTimeseriesDataMetricID = "stability_score" GetTimeseriesDataMetricIDBufferRatio GetTimeseriesDataMetricID = "buffer_ratio" GetTimeseriesDataMetricIDBufferFrequency GetTimeseriesDataMetricID = "buffer_frequency" GetTimeseriesDataMetricIDBufferFill GetTimeseriesDataMetricID = "buffer_fill" )
func (GetTimeseriesDataMetricID) ToPointer ¶ added in v1.0.0
func (e GetTimeseriesDataMetricID) ToPointer() *GetTimeseriesDataMetricID
func (*GetTimeseriesDataMetricID) UnmarshalJSON ¶ added in v1.0.0
func (e *GetTimeseriesDataMetricID) UnmarshalJSON(data []byte) error
type GetTimeseriesDataRequest ¶ added in v1.0.0
type GetTimeseriesDataRequest struct {
// Pass metric Id
//
MetricID GetTimeseriesDataMetricID `pathParam:"style=simple,explode=false,name=metricId"`
// Pass this value to group the metrics list by.
//
GroupBy *GroupBy `default:"minute" queryParam:"style=form,explode=true,name=groupBy"`
// The order direction to sort the metrics list by.
//
SortOrder *GetTimeseriesDataSortOrder `default:"asc" queryParam:"style=form,explode=true,name=sortOrder"`
// The measurement for the given metrics.
// Possible Values : [95th, median, avg, count or sum]
//
Measurement *string `default:"avg" queryParam:"style=form,explode=true,name=measurement"`
// This parameter specifies the time span between which the video views list should be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.
//
Timespan GetTimeseriesDataTimespan `queryParam:"style=form,explode=true,name=timespan[]"`
// Pass the dimensions and their corresponding values you want to filter the views by. For excluding the values in the filter we can pass '!' before the filter value. The list of filters can be obtained from list of dimensions endpoint.
// Example Values : [ browser_name:Chrome , os_name:macOS , device_name:Galaxy ]
//
Filterby *string `queryParam:"style=form,explode=true,name=filterby[]"`
}
func (*GetTimeseriesDataRequest) GetFilterby ¶ added in v1.0.0
func (g *GetTimeseriesDataRequest) GetFilterby() *string
func (*GetTimeseriesDataRequest) GetGroupBy ¶ added in v1.0.0
func (g *GetTimeseriesDataRequest) GetGroupBy() *GroupBy
func (*GetTimeseriesDataRequest) GetMeasurement ¶ added in v1.0.0
func (g *GetTimeseriesDataRequest) GetMeasurement() *string
func (*GetTimeseriesDataRequest) GetMetricID ¶ added in v1.0.0
func (g *GetTimeseriesDataRequest) GetMetricID() GetTimeseriesDataMetricID
func (*GetTimeseriesDataRequest) GetSortOrder ¶ added in v1.0.0
func (g *GetTimeseriesDataRequest) GetSortOrder() *GetTimeseriesDataSortOrder
func (*GetTimeseriesDataRequest) GetTimespan ¶ added in v1.0.0
func (g *GetTimeseriesDataRequest) GetTimespan() GetTimeseriesDataTimespan
func (GetTimeseriesDataRequest) MarshalJSON ¶ added in v1.0.0
func (g GetTimeseriesDataRequest) MarshalJSON() ([]byte, error)
func (*GetTimeseriesDataRequest) UnmarshalJSON ¶ added in v1.0.0
func (g *GetTimeseriesDataRequest) UnmarshalJSON(data []byte) error
type GetTimeseriesDataResponse ¶ added in v1.0.0
type GetTimeseriesDataResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Get filter/ dimension value details by dimension name.
Object *GetTimeseriesDataResponseBody
}
func (*GetTimeseriesDataResponse) GetHTTPMeta ¶ added in v1.0.0
func (g *GetTimeseriesDataResponse) GetHTTPMeta() components.HTTPMetadata
func (*GetTimeseriesDataResponse) GetObject ¶ added in v1.0.0
func (g *GetTimeseriesDataResponse) GetObject() *GetTimeseriesDataResponseBody
type GetTimeseriesDataResponseBody ¶ added in v1.0.0
type GetTimeseriesDataResponseBody struct {
// It demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
// Retrieves breakdown values for a specified metric and timespan
MetaData *components.MetricsTimeseriesMetaDataDetails `json:"metaData,omitempty"`
// Displays the result of the request.
Data []components.MetricsTimeseriesDataDetails `json:"data,omitempty"`
// The timeframe from and to details displayed in the form of unix epoch timestamps.
//
Timespan []int64 `json:"timespan,omitempty"`
}
GetTimeseriesDataResponseBody - Get filter/ dimension value details by dimension name.
func (*GetTimeseriesDataResponseBody) GetData ¶ added in v1.0.0
func (g *GetTimeseriesDataResponseBody) GetData() []components.MetricsTimeseriesDataDetails
func (*GetTimeseriesDataResponseBody) GetMetaData ¶ added in v1.0.0
func (g *GetTimeseriesDataResponseBody) GetMetaData() *components.MetricsTimeseriesMetaDataDetails
func (*GetTimeseriesDataResponseBody) GetSuccess ¶ added in v1.0.0
func (g *GetTimeseriesDataResponseBody) GetSuccess() *bool
func (*GetTimeseriesDataResponseBody) GetTimespan ¶ added in v1.0.0
func (g *GetTimeseriesDataResponseBody) GetTimespan() []int64
type GetTimeseriesDataSortOrder ¶ added in v1.0.0
type GetTimeseriesDataSortOrder string
GetTimeseriesDataSortOrder - The order direction to sort the metrics list by.
const ( GetTimeseriesDataSortOrderAsc GetTimeseriesDataSortOrder = "asc" GetTimeseriesDataSortOrderDesc GetTimeseriesDataSortOrder = "desc" )
func (GetTimeseriesDataSortOrder) ToPointer ¶ added in v1.0.0
func (e GetTimeseriesDataSortOrder) ToPointer() *GetTimeseriesDataSortOrder
func (*GetTimeseriesDataSortOrder) UnmarshalJSON ¶ added in v1.0.0
func (e *GetTimeseriesDataSortOrder) UnmarshalJSON(data []byte) error
type GetTimeseriesDataTimespan ¶ added in v1.0.0
type GetTimeseriesDataTimespan string
GetTimeseriesDataTimespan - This parameter specifies the time span between which the video views list should be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.
const ( GetTimeseriesDataTimespanSixtyminutes GetTimeseriesDataTimespan = "60:minutes" GetTimeseriesDataTimespanSixhours GetTimeseriesDataTimespan = "6:hours" GetTimeseriesDataTimespanTwentyFourhours GetTimeseriesDataTimespan = "24:hours" GetTimeseriesDataTimespanThreedays GetTimeseriesDataTimespan = "3:days" GetTimeseriesDataTimespanSevendays GetTimeseriesDataTimespan = "7:days" GetTimeseriesDataTimespanThirtydays GetTimeseriesDataTimespan = "30:days" )
func (GetTimeseriesDataTimespan) ToPointer ¶ added in v1.0.0
func (e GetTimeseriesDataTimespan) ToPointer() *GetTimeseriesDataTimespan
func (*GetTimeseriesDataTimespan) UnmarshalJSON ¶ added in v1.0.0
func (e *GetTimeseriesDataTimespan) UnmarshalJSON(data []byte) error
type GetVideoViewDetailsRequest ¶ added in v1.0.0
type GetVideoViewDetailsRequest struct {
// Pass View id
ViewID string `pathParam:"style=simple,explode=false,name=viewId"`
}
func (*GetVideoViewDetailsRequest) GetViewID ¶ added in v1.0.0
func (g *GetVideoViewDetailsRequest) GetViewID() string
type GetVideoViewDetailsResponse ¶ added in v1.0.0
type GetVideoViewDetailsResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Get a video view by id
Object *GetVideoViewDetailsResponseBody
}
func (*GetVideoViewDetailsResponse) GetHTTPMeta ¶ added in v1.0.0
func (g *GetVideoViewDetailsResponse) GetHTTPMeta() components.HTTPMetadata
func (*GetVideoViewDetailsResponse) GetObject ¶ added in v1.0.0
func (g *GetVideoViewDetailsResponse) GetObject() *GetVideoViewDetailsResponseBody
type GetVideoViewDetailsResponseBody ¶ added in v1.0.0
type GetVideoViewDetailsResponseBody struct {
// It demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
// Displays the result of the request.
Data *components.Views `json:"data,omitempty"`
}
GetVideoViewDetailsResponseBody - Get a video view by id
func (*GetVideoViewDetailsResponseBody) GetData ¶ added in v1.0.0
func (g *GetVideoViewDetailsResponseBody) GetData() *components.Views
func (*GetVideoViewDetailsResponseBody) GetSuccess ¶ added in v1.0.0
func (g *GetVideoViewDetailsResponseBody) GetSuccess() *bool
type GroupBy ¶ added in v1.0.0
type GroupBy string
GroupBy - Pass this value to group the metrics list by.
func (*GroupBy) UnmarshalJSON ¶ added in v1.0.0
type Input ¶
type Input struct {
VideoInput *components.VideoInput `queryParam:"inline,name=input"`
WatermarkInput *components.WatermarkInput `queryParam:"inline,name=input"`
AudioInput *components.AudioInput `queryParam:"inline,name=input"`
SubtitleInput *components.SubtitleInput `queryParam:"inline,name=input"`
Type InputType
}
func CreateInputAudioInput ¶
func CreateInputAudioInput(audioInput components.AudioInput) Input
func CreateInputSubtitleInput ¶
func CreateInputSubtitleInput(subtitleInput components.SubtitleInput) Input
func CreateInputVideoInput ¶
func CreateInputVideoInput(videoInput components.VideoInput) Input
func CreateInputWatermarkInput ¶
func CreateInputWatermarkInput(watermarkInput components.WatermarkInput) Input
func (Input) MarshalJSON ¶
func (*Input) UnmarshalJSON ¶
type LanguageCode ¶
type LanguageCode string
LanguageCode - Language codes (BCP 47 compliant) used for text files.
const ( LanguageCodeEn LanguageCode = "en" LanguageCodeIt LanguageCode = "it" LanguageCodePl LanguageCode = "pl" LanguageCodeEs LanguageCode = "es" LanguageCodeFr LanguageCode = "fr" LanguageCodeRu LanguageCode = "ru" LanguageCodeNl LanguageCode = "nl" )
func (LanguageCode) ToPointer ¶
func (e LanguageCode) ToPointer() *LanguageCode
func (*LanguageCode) UnmarshalJSON ¶
func (e *LanguageCode) UnmarshalJSON(data []byte) error
type ListBreakdownValuesMetricID ¶ added in v1.0.0
type ListBreakdownValuesMetricID string
ListBreakdownValuesMetricID - Pass metric Id
const ( ListBreakdownValuesMetricIDViews ListBreakdownValuesMetricID = "views" ListBreakdownValuesMetricIDUniqueViewers ListBreakdownValuesMetricID = "unique_viewers" ListBreakdownValuesMetricIDPlayingTime ListBreakdownValuesMetricID = "playing_time" ListBreakdownValuesMetricIDQualityOfExperienceScore ListBreakdownValuesMetricID = "quality_of_experience_score" ListBreakdownValuesMetricIDPlaybackScore ListBreakdownValuesMetricID = "playback_score" ListBreakdownValuesMetricIDPlaybackFailurePercentage ListBreakdownValuesMetricID = "playback_failure_percentage" ListBreakdownValuesMetricIDExitBeforeVideoStart ListBreakdownValuesMetricID = "exit_before_video_start" ListBreakdownValuesMetricIDVideoStartupFailurePercentage ListBreakdownValuesMetricID = "video_startup_failure_percentage" ListBreakdownValuesMetricIDStartupScore ListBreakdownValuesMetricID = "startup_score" ListBreakdownValuesMetricIDVideoStartupTime ListBreakdownValuesMetricID = "video_startup_time" ListBreakdownValuesMetricIDPlayerStartupTime ListBreakdownValuesMetricID = "player_startup_time" ListBreakdownValuesMetricIDPageLoadTime ListBreakdownValuesMetricID = "page_load_time" ListBreakdownValuesMetricIDTotalStartupTime ListBreakdownValuesMetricID = "total_startup_time" ListBreakdownValuesMetricIDLiveStreamLatency ListBreakdownValuesMetricID = "live_stream_latency" ListBreakdownValuesMetricIDAverageBitrate ListBreakdownValuesMetricID = "average_bitrate" ListBreakdownValuesMetricIDBufferCount ListBreakdownValuesMetricID = "buffer_count" ListBreakdownValuesMetricIDRenderQualityScore ListBreakdownValuesMetricID = "render_quality_score" ListBreakdownValuesMetricIDAvgUpscaling ListBreakdownValuesMetricID = "avg_upscaling" ListBreakdownValuesMetricIDAvgDownscaling ListBreakdownValuesMetricID = "avg_downscaling" ListBreakdownValuesMetricIDMaxUpscaling ListBreakdownValuesMetricID = "max_upscaling" ListBreakdownValuesMetricIDMaxDownscaling ListBreakdownValuesMetricID = "max_downscaling" ListBreakdownValuesMetricIDJumpLatency ListBreakdownValuesMetricID = "jump_latency" ListBreakdownValuesMetricIDStabilityScore ListBreakdownValuesMetricID = "stability_score" ListBreakdownValuesMetricIDBufferRatio ListBreakdownValuesMetricID = "buffer_ratio" ListBreakdownValuesMetricIDBufferFrequency ListBreakdownValuesMetricID = "buffer_frequency" ListBreakdownValuesMetricIDBufferFill ListBreakdownValuesMetricID = "buffer_fill" )
func (ListBreakdownValuesMetricID) ToPointer ¶ added in v1.0.0
func (e ListBreakdownValuesMetricID) ToPointer() *ListBreakdownValuesMetricID
func (*ListBreakdownValuesMetricID) UnmarshalJSON ¶ added in v1.0.0
func (e *ListBreakdownValuesMetricID) UnmarshalJSON(data []byte) error
type ListBreakdownValuesRequest ¶ added in v1.0.0
type ListBreakdownValuesRequest struct {
// Pass metric Id
//
MetricID ListBreakdownValuesMetricID `pathParam:"style=simple,explode=false,name=metricId"`
// This parameter specifies the time span between which the video views list should be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.
//
Timespan ListBreakdownValuesTimespan `queryParam:"style=form,explode=true,name=timespan[]"`
// Pass the dimensions and their corresponding values you want to filter the views by. For excluding the values in the filter we can pass '!' before the filter value. The list of filters can be obtained from list of dimensions endpoint.
// Example Values : [ browser_name:Chrome , os_name:macOS , device_name:Galaxy ]
//
Filterby *string `queryParam:"style=form,explode=true,name=filterby[]"`
// Pass the limit to display only the rows specified by the value.
//
Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
// Pass the offset value to indicate the page number.
//
Offset *int64 `default:"1" queryParam:"style=form,explode=true,name=offset"`
// Pass this value to group the metrics list by.
// Possible Values : ["browser_name", "browser_version", "os_name","os_version" , "device_name", "device_model", "device_type", "device_manufacturer", "player_remote_played",player_name", "player_version", "player_software_name", "player_software_version", "player_resolution", "fp_sdk","fp_sdk_version", "player_autoplay_on", "player_preload_on","video_title", "video_id", "video_series" , "fp_playback_id","fp_live_stream_id", "media_id","video_source_stream_type", "video_source_type", "video_encoding_variant", "experiment_name", "sub_property_id", "drm_type","asn_name", "cdn", "video_source_hostname", "connection_type", "view_session_id","continent","country", "region","viewer_id", "error_code", "exit_before_video_start", "view_has_ad", "video_startup_failed" , "page_context", "playback_failed".]
//
GroupBy *string `queryParam:"style=form,explode=true,name=groupBy"`
// Pass this value to order the metrics list by.
//
OrderBy *string `default:"views" queryParam:"style=form,explode=true,name=orderBy"`
// The order direction to sort the metrics list by.
//
SortOrder *ListBreakdownValuesSortOrder `default:"asc" queryParam:"style=form,explode=true,name=sortOrder"`
// The measurement for the given metrics.
//
Measurement *string `default:"avg" queryParam:"style=form,explode=true,name=measurement"`
}
func (*ListBreakdownValuesRequest) GetFilterby ¶ added in v1.0.0
func (l *ListBreakdownValuesRequest) GetFilterby() *string
func (*ListBreakdownValuesRequest) GetGroupBy ¶ added in v1.0.0
func (l *ListBreakdownValuesRequest) GetGroupBy() *string
func (*ListBreakdownValuesRequest) GetLimit ¶ added in v1.0.0
func (l *ListBreakdownValuesRequest) GetLimit() *int64
func (*ListBreakdownValuesRequest) GetMeasurement ¶ added in v1.0.0
func (l *ListBreakdownValuesRequest) GetMeasurement() *string
func (*ListBreakdownValuesRequest) GetMetricID ¶ added in v1.0.0
func (l *ListBreakdownValuesRequest) GetMetricID() ListBreakdownValuesMetricID
func (*ListBreakdownValuesRequest) GetOffset ¶ added in v1.0.0
func (l *ListBreakdownValuesRequest) GetOffset() *int64
func (*ListBreakdownValuesRequest) GetOrderBy ¶ added in v1.0.0
func (l *ListBreakdownValuesRequest) GetOrderBy() *string
func (*ListBreakdownValuesRequest) GetSortOrder ¶ added in v1.0.0
func (l *ListBreakdownValuesRequest) GetSortOrder() *ListBreakdownValuesSortOrder
func (*ListBreakdownValuesRequest) GetTimespan ¶ added in v1.0.0
func (l *ListBreakdownValuesRequest) GetTimespan() ListBreakdownValuesTimespan
func (ListBreakdownValuesRequest) MarshalJSON ¶ added in v1.0.0
func (l ListBreakdownValuesRequest) MarshalJSON() ([]byte, error)
func (*ListBreakdownValuesRequest) UnmarshalJSON ¶ added in v1.0.0
func (l *ListBreakdownValuesRequest) UnmarshalJSON(data []byte) error
type ListBreakdownValuesResponse ¶ added in v1.0.0
type ListBreakdownValuesResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Get filter/ dimension value details by dimension name.
Object *ListBreakdownValuesResponseBody
}
func (*ListBreakdownValuesResponse) GetHTTPMeta ¶ added in v1.0.0
func (l *ListBreakdownValuesResponse) GetHTTPMeta() components.HTTPMetadata
func (*ListBreakdownValuesResponse) GetObject ¶ added in v1.0.0
func (l *ListBreakdownValuesResponse) GetObject() *ListBreakdownValuesResponseBody
type ListBreakdownValuesResponseBody ¶ added in v1.0.0
type ListBreakdownValuesResponseBody struct {
// It demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
// Retrieves breakdown values for a specified metric and timespan
MetaData *components.MetricsTimeseriesMetaDataDetails `json:"metaData,omitempty"`
// Retrieves breakdown values for a specified metric and timespan
Data []components.MetricsBreakdownDetails `json:"data,omitempty"`
// The timeframe from and to details displayed in the form of unix epoch timestamps.
//
Timespan []int64 `json:"timespan,omitempty"`
}
ListBreakdownValuesResponseBody - Get filter/ dimension value details by dimension name.
func (*ListBreakdownValuesResponseBody) GetData ¶ added in v1.0.0
func (l *ListBreakdownValuesResponseBody) GetData() []components.MetricsBreakdownDetails
func (*ListBreakdownValuesResponseBody) GetMetaData ¶ added in v1.0.0
func (l *ListBreakdownValuesResponseBody) GetMetaData() *components.MetricsTimeseriesMetaDataDetails
func (*ListBreakdownValuesResponseBody) GetSuccess ¶ added in v1.0.0
func (l *ListBreakdownValuesResponseBody) GetSuccess() *bool
func (*ListBreakdownValuesResponseBody) GetTimespan ¶ added in v1.0.0
func (l *ListBreakdownValuesResponseBody) GetTimespan() []int64
type ListBreakdownValuesSortOrder ¶ added in v1.0.0
type ListBreakdownValuesSortOrder string
ListBreakdownValuesSortOrder - The order direction to sort the metrics list by.
const ( ListBreakdownValuesSortOrderAsc ListBreakdownValuesSortOrder = "asc" ListBreakdownValuesSortOrderDesc ListBreakdownValuesSortOrder = "desc" )
func (ListBreakdownValuesSortOrder) ToPointer ¶ added in v1.0.0
func (e ListBreakdownValuesSortOrder) ToPointer() *ListBreakdownValuesSortOrder
func (*ListBreakdownValuesSortOrder) UnmarshalJSON ¶ added in v1.0.0
func (e *ListBreakdownValuesSortOrder) UnmarshalJSON(data []byte) error
type ListBreakdownValuesTimespan ¶ added in v1.0.0
type ListBreakdownValuesTimespan string
ListBreakdownValuesTimespan - This parameter specifies the time span between which the video views list should be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.
const ( ListBreakdownValuesTimespanSixtyminutes ListBreakdownValuesTimespan = "60:minutes" ListBreakdownValuesTimespanSixhours ListBreakdownValuesTimespan = "6:hours" ListBreakdownValuesTimespanTwentyFourhours ListBreakdownValuesTimespan = "24:hours" ListBreakdownValuesTimespanThreedays ListBreakdownValuesTimespan = "3:days" ListBreakdownValuesTimespanSevendays ListBreakdownValuesTimespan = "7:days" ListBreakdownValuesTimespanThirtydays ListBreakdownValuesTimespan = "30:days" )
func (ListBreakdownValuesTimespan) ToPointer ¶ added in v1.0.0
func (e ListBreakdownValuesTimespan) ToPointer() *ListBreakdownValuesTimespan
func (*ListBreakdownValuesTimespan) UnmarshalJSON ¶ added in v1.0.0
func (e *ListBreakdownValuesTimespan) UnmarshalJSON(data []byte) error
type ListByTopContentRequest ¶ added in v1.0.0
type ListByTopContentRequest struct {
// This parameter specifies the time span between which the video views list should be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.
//
Timespan ListByTopContentTimespan `queryParam:"style=form,explode=true,name=timespan[]"`
// Pass the dimensions and their corresponding values you want to filter the views by. For excluding the values in the filter we can pass '!' before the filter value. The list of filters can be obtained from list of dimensions endpoint.
// Example Values : [ browser_name:Chrome , os_name:macOS , device_name:Galaxy ]
//
Filterby *string `queryParam:"style=form,explode=true,name=filterby[]"`
// Pass the limit to display only the rows specified by the value.
//
Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
}
func (*ListByTopContentRequest) GetFilterby ¶ added in v1.0.0
func (l *ListByTopContentRequest) GetFilterby() *string
func (*ListByTopContentRequest) GetLimit ¶ added in v1.0.0
func (l *ListByTopContentRequest) GetLimit() *int64
func (*ListByTopContentRequest) GetTimespan ¶ added in v1.0.0
func (l *ListByTopContentRequest) GetTimespan() ListByTopContentTimespan
func (ListByTopContentRequest) MarshalJSON ¶ added in v1.0.0
func (l ListByTopContentRequest) MarshalJSON() ([]byte, error)
func (*ListByTopContentRequest) UnmarshalJSON ¶ added in v1.0.0
func (l *ListByTopContentRequest) UnmarshalJSON(data []byte) error
type ListByTopContentResponse ¶ added in v1.0.0
type ListByTopContentResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Get the list of Views
Object *ListByTopContentResponseBody
}
func (*ListByTopContentResponse) GetHTTPMeta ¶ added in v1.0.0
func (l *ListByTopContentResponse) GetHTTPMeta() components.HTTPMetadata
func (*ListByTopContentResponse) GetObject ¶ added in v1.0.0
func (l *ListByTopContentResponse) GetObject() *ListByTopContentResponseBody
type ListByTopContentResponseBody ¶ added in v1.0.0
type ListByTopContentResponseBody struct {
// It demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
// Displays the result of the request.
Data []components.ViewsByTopContentDetails `json:"data,omitempty"`
}
ListByTopContentResponseBody - Get the list of Views
func (*ListByTopContentResponseBody) GetData ¶ added in v1.0.0
func (l *ListByTopContentResponseBody) GetData() []components.ViewsByTopContentDetails
func (*ListByTopContentResponseBody) GetSuccess ¶ added in v1.0.0
func (l *ListByTopContentResponseBody) GetSuccess() *bool
type ListByTopContentTimespan ¶ added in v1.0.0
type ListByTopContentTimespan string
ListByTopContentTimespan - This parameter specifies the time span between which the video views list should be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.
const ( ListByTopContentTimespanSixtyminutes ListByTopContentTimespan = "60:minutes" ListByTopContentTimespanSixhours ListByTopContentTimespan = "6:hours" ListByTopContentTimespanTwentyFourhours ListByTopContentTimespan = "24:hours" ListByTopContentTimespanThreedays ListByTopContentTimespan = "3:days" ListByTopContentTimespanSevendays ListByTopContentTimespan = "7:days" ListByTopContentTimespanThirtydays ListByTopContentTimespan = "30:days" )
func (ListByTopContentTimespan) ToPointer ¶ added in v1.0.0
func (e ListByTopContentTimespan) ToPointer() *ListByTopContentTimespan
func (*ListByTopContentTimespan) UnmarshalJSON ¶ added in v1.0.0
func (e *ListByTopContentTimespan) UnmarshalJSON(data []byte) error
type ListComparisonValuesDimension ¶ added in v1.0.0
type ListComparisonValuesDimension string
ListComparisonValuesDimension - The dimension id in which the views are watched.
const ( ListComparisonValuesDimensionBrowserName ListComparisonValuesDimension = "browser_name" ListComparisonValuesDimensionBrowserVersion ListComparisonValuesDimension = "browser_version" ListComparisonValuesDimensionOsName ListComparisonValuesDimension = "os_name" ListComparisonValuesDimensionOsVersion ListComparisonValuesDimension = "os_version" ListComparisonValuesDimensionDeviceName ListComparisonValuesDimension = "device_name" ListComparisonValuesDimensionDeviceModel ListComparisonValuesDimension = "device_model" ListComparisonValuesDimensionDeviceType ListComparisonValuesDimension = "device_type" ListComparisonValuesDimensionDeviceManufacturer ListComparisonValuesDimension = "device_manufacturer" ListComparisonValuesDimensionPlayerRemotePlayed ListComparisonValuesDimension = "player_remote_played" ListComparisonValuesDimensionPlayerName ListComparisonValuesDimension = "player_name" ListComparisonValuesDimensionPlayerVersion ListComparisonValuesDimension = "player_version" ListComparisonValuesDimensionPlayerSoftwareName ListComparisonValuesDimension = "player_software_name" ListComparisonValuesDimensionPlayerSoftwareVersion ListComparisonValuesDimension = "player_software_version" ListComparisonValuesDimensionPlayerResolution ListComparisonValuesDimension = "player_resolution" ListComparisonValuesDimensionFpSDK ListComparisonValuesDimension = "fp_sdk" ListComparisonValuesDimensionFpSDKVersion ListComparisonValuesDimension = "fp_sdk_version" ListComparisonValuesDimensionPlayerAutoplayOn ListComparisonValuesDimension = "player_autoplay_on" ListComparisonValuesDimensionPlayerPreloadOn ListComparisonValuesDimension = "player_preload_on" ListComparisonValuesDimensionVideoTitle ListComparisonValuesDimension = "video_title" ListComparisonValuesDimensionVideoID ListComparisonValuesDimension = "video_id" ListComparisonValuesDimensionVideoSeries ListComparisonValuesDimension = "video_series" ListComparisonValuesDimensionFpPlaybackID ListComparisonValuesDimension = "fp_playback_id" ListComparisonValuesDimensionFpLiveStreamID ListComparisonValuesDimension = "fp_live_stream_id" ListComparisonValuesDimensionMediaID ListComparisonValuesDimension = "media_id" ListComparisonValuesDimensionVideoSourceStreamType ListComparisonValuesDimension = "video_source_stream_type" ListComparisonValuesDimensionVideoSourceType ListComparisonValuesDimension = "video_source_type" ListComparisonValuesDimensionVideoEncodingVariant ListComparisonValuesDimension = "video_encoding_variant" ListComparisonValuesDimensionExperimentName ListComparisonValuesDimension = "experiment_name" ListComparisonValuesDimensionSubPropertyID ListComparisonValuesDimension = "sub_property_id" ListComparisonValuesDimensionDrmType ListComparisonValuesDimension = "drm_type" ListComparisonValuesDimensionAsnName ListComparisonValuesDimension = "asn_name" ListComparisonValuesDimensionCdn ListComparisonValuesDimension = "cdn" ListComparisonValuesDimensionVideoSourceHostname ListComparisonValuesDimension = "video_source_hostname" ListComparisonValuesDimensionConnectionType ListComparisonValuesDimension = "connection_type" ListComparisonValuesDimensionViewSessionID ListComparisonValuesDimension = "view_session_id" ListComparisonValuesDimensionContinent ListComparisonValuesDimension = "continent" ListComparisonValuesDimensionCountry ListComparisonValuesDimension = "country" ListComparisonValuesDimensionRegion ListComparisonValuesDimension = "region" ListComparisonValuesDimensionViewerID ListComparisonValuesDimension = "viewer_id" ListComparisonValuesDimensionErrorCode ListComparisonValuesDimension = "error_code" ListComparisonValuesDimensionExitBeforeVideoStart ListComparisonValuesDimension = "exit_before_video_start" ListComparisonValuesDimensionViewHasAd ListComparisonValuesDimension = "view_has_ad" ListComparisonValuesDimensionVideoStartupFailed ListComparisonValuesDimension = "video_startup_failed" ListComparisonValuesDimensionPageContext ListComparisonValuesDimension = "page_context" ListComparisonValuesDimensionPlaybackFailed ListComparisonValuesDimension = "playback_failed" ListComparisonValuesDimensionCustom1 ListComparisonValuesDimension = "custom_1" ListComparisonValuesDimensionCustom2 ListComparisonValuesDimension = "custom_2" ListComparisonValuesDimensionCustom3 ListComparisonValuesDimension = "custom_3" ListComparisonValuesDimensionCustom4 ListComparisonValuesDimension = "custom_4" ListComparisonValuesDimensionCustom5 ListComparisonValuesDimension = "custom_5" ListComparisonValuesDimensionCustom6 ListComparisonValuesDimension = "custom_6" ListComparisonValuesDimensionCustom7 ListComparisonValuesDimension = "custom_7" ListComparisonValuesDimensionCustom8 ListComparisonValuesDimension = "custom_8" ListComparisonValuesDimensionCustom9 ListComparisonValuesDimension = "custom_9" ListComparisonValuesDimensionCustom10 ListComparisonValuesDimension = "custom_10" )
func (ListComparisonValuesDimension) ToPointer ¶ added in v1.0.0
func (e ListComparisonValuesDimension) ToPointer() *ListComparisonValuesDimension
func (*ListComparisonValuesDimension) UnmarshalJSON ¶ added in v1.0.0
func (e *ListComparisonValuesDimension) UnmarshalJSON(data []byte) error
type ListComparisonValuesRequest ¶ added in v1.0.0
type ListComparisonValuesRequest struct {
// This parameter specifies the time span between which the video views list should be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.
//
Timespan ListComparisonValuesTimespan `queryParam:"style=form,explode=true,name=timespan[]"`
// Pass the dimensions and their corresponding values you want to filter the views by. For excluding the values in the filter we can pass '!' before the filter value. The list of filters can be obtained from list of dimensions endpoint.
// Example Values : [ browser_name:Chrome , os_name:macOS , device_name:Galaxy ]
//
Filterby *string `queryParam:"style=form,explode=true,name=filterby[]"`
// The dimension id in which the views are watched.
//
Dimension *ListComparisonValuesDimension `queryParam:"style=form,explode=true,name=dimension"`
// The value for the selected dimension.
// For example:
// If `dimension` is `browser_name`, the value could be `Chrome` `,` `Firefox` `etc` .
// If `dimension` is `os_name`, the value could be `macOS` `,` `Windows` `etc` .
//
Value *string `queryParam:"style=form,explode=true,name=value"`
}
func (*ListComparisonValuesRequest) GetDimension ¶ added in v1.0.0
func (l *ListComparisonValuesRequest) GetDimension() *ListComparisonValuesDimension
func (*ListComparisonValuesRequest) GetFilterby ¶ added in v1.0.0
func (l *ListComparisonValuesRequest) GetFilterby() *string
func (*ListComparisonValuesRequest) GetTimespan ¶ added in v1.0.0
func (l *ListComparisonValuesRequest) GetTimespan() ListComparisonValuesTimespan
func (*ListComparisonValuesRequest) GetValue ¶ added in v1.0.0
func (l *ListComparisonValuesRequest) GetValue() *string
type ListComparisonValuesResponse ¶ added in v1.0.0
type ListComparisonValuesResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Get filter/ dimension value details by dimension name.
Object *ListComparisonValuesResponseBody
}
func (*ListComparisonValuesResponse) GetHTTPMeta ¶ added in v1.0.0
func (l *ListComparisonValuesResponse) GetHTTPMeta() components.HTTPMetadata
func (*ListComparisonValuesResponse) GetObject ¶ added in v1.0.0
func (l *ListComparisonValuesResponse) GetObject() *ListComparisonValuesResponseBody
type ListComparisonValuesResponseBody ¶ added in v1.0.0
type ListComparisonValuesResponseBody struct {
// It demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
// Displays the result of the request.
//
Data [][]components.MetricsComparisonDetails `json:"data,omitempty"`
// The timeframe from and to details displayed in the form of unix epoch timestamps.
//
Timespan []int64 `json:"timespan,omitempty"`
}
ListComparisonValuesResponseBody - Get filter/ dimension value details by dimension name.
func (*ListComparisonValuesResponseBody) GetData ¶ added in v1.0.0
func (l *ListComparisonValuesResponseBody) GetData() [][]components.MetricsComparisonDetails
func (*ListComparisonValuesResponseBody) GetSuccess ¶ added in v1.0.0
func (l *ListComparisonValuesResponseBody) GetSuccess() *bool
func (*ListComparisonValuesResponseBody) GetTimespan ¶ added in v1.0.0
func (l *ListComparisonValuesResponseBody) GetTimespan() []int64
type ListComparisonValuesTimespan ¶ added in v1.0.0
type ListComparisonValuesTimespan string
ListComparisonValuesTimespan - This parameter specifies the time span between which the video views list should be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.
const ( ListComparisonValuesTimespanSixtyminutes ListComparisonValuesTimespan = "60:minutes" ListComparisonValuesTimespanSixhours ListComparisonValuesTimespan = "6:hours" ListComparisonValuesTimespanTwentyFourhours ListComparisonValuesTimespan = "24:hours" ListComparisonValuesTimespanThreedays ListComparisonValuesTimespan = "3:days" ListComparisonValuesTimespanSevendays ListComparisonValuesTimespan = "7:days" ListComparisonValuesTimespanThirtydays ListComparisonValuesTimespan = "30:days" )
func (ListComparisonValuesTimespan) ToPointer ¶ added in v1.0.0
func (e ListComparisonValuesTimespan) ToPointer() *ListComparisonValuesTimespan
func (*ListComparisonValuesTimespan) UnmarshalJSON ¶ added in v1.0.0
func (e *ListComparisonValuesTimespan) UnmarshalJSON(data []byte) error
type ListDimensionsResponse ¶ added in v1.0.0
type ListDimensionsResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Get the list of Views
Object *ListDimensionsResponseBody
}
func (*ListDimensionsResponse) GetHTTPMeta ¶ added in v1.0.0
func (l *ListDimensionsResponse) GetHTTPMeta() components.HTTPMetadata
func (*ListDimensionsResponse) GetObject ¶ added in v1.0.0
func (l *ListDimensionsResponse) GetObject() *ListDimensionsResponseBody
type ListDimensionsResponseBody ¶ added in v1.0.0
type ListDimensionsResponseBody struct {
// It demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
// Displays the result of the request.
Data []string `json:"data,omitempty"`
}
ListDimensionsResponseBody - Get the list of Views
func (*ListDimensionsResponseBody) GetData ¶ added in v1.0.0
func (l *ListDimensionsResponseBody) GetData() []string
func (*ListDimensionsResponseBody) GetSuccess ¶ added in v1.0.0
func (l *ListDimensionsResponseBody) GetSuccess() *bool
type ListErrorsData ¶ added in v1.0.0
type ListErrorsData struct {
// Retrieves a list of errors that have occurred in the system.
Errors []components.ErrorDetails `json:"errors,omitempty"`
// Retrieves a list of errors that have occurred most frequently in the system, ranked by their count of occurrences.
TopErrors []components.TopErrorDetails `json:"topErrors,omitempty"`
}
ListErrorsData - Displays the result of the request.
func (*ListErrorsData) GetErrors ¶ added in v1.0.0
func (l *ListErrorsData) GetErrors() []components.ErrorDetails
func (*ListErrorsData) GetTopErrors ¶ added in v1.0.0
func (l *ListErrorsData) GetTopErrors() []components.TopErrorDetails
type ListErrorsRequest ¶ added in v1.0.0
type ListErrorsRequest struct {
// This parameter specifies the time span between which the video views list should be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.
//
Timespan ListErrorsTimespan `queryParam:"style=form,explode=true,name=timespan[]"`
// Pass the dimensions and their corresponding values you want to filter the views by. For excluding the values in the filter we can pass '!' before the filter value. The list of filters can be obtained from list of dimensions endpoint.
// Example Values : [ browser_name:Chrome , os_name:macOS , device_name:Galaxy ]
//
Filterby *string `queryParam:"style=form,explode=true,name=filterby[]"`
// Pass the limit to display only the rows specified by the value for top errors.
//
Limit *int64 `default:"1" queryParam:"style=form,explode=true,name=limit"`
}
func (*ListErrorsRequest) GetFilterby ¶ added in v1.0.0
func (l *ListErrorsRequest) GetFilterby() *string
func (*ListErrorsRequest) GetLimit ¶ added in v1.0.0
func (l *ListErrorsRequest) GetLimit() *int64
func (*ListErrorsRequest) GetTimespan ¶ added in v1.0.0
func (l *ListErrorsRequest) GetTimespan() ListErrorsTimespan
func (ListErrorsRequest) MarshalJSON ¶ added in v1.0.0
func (l ListErrorsRequest) MarshalJSON() ([]byte, error)
func (*ListErrorsRequest) UnmarshalJSON ¶ added in v1.0.0
func (l *ListErrorsRequest) UnmarshalJSON(data []byte) error
type ListErrorsResponse ¶ added in v1.0.0
type ListErrorsResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Get filter/ dimension value details by dimension name.
Object *ListErrorsResponseBody
}
func (*ListErrorsResponse) GetHTTPMeta ¶ added in v1.0.0
func (l *ListErrorsResponse) GetHTTPMeta() components.HTTPMetadata
func (*ListErrorsResponse) GetObject ¶ added in v1.0.0
func (l *ListErrorsResponse) GetObject() *ListErrorsResponseBody
type ListErrorsResponseBody ¶ added in v1.0.0
type ListErrorsResponseBody struct {
// It demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
// Displays the result of the request.
Data *ListErrorsData `json:"data,omitempty"`
// The timeframe from and to details displayed in the form of unix epoch timestamps.
//
Timespan []int64 `json:"timespan,omitempty"`
}
ListErrorsResponseBody - Get filter/ dimension value details by dimension name.
func (*ListErrorsResponseBody) GetData ¶ added in v1.0.0
func (l *ListErrorsResponseBody) GetData() *ListErrorsData
func (*ListErrorsResponseBody) GetSuccess ¶ added in v1.0.0
func (l *ListErrorsResponseBody) GetSuccess() *bool
func (*ListErrorsResponseBody) GetTimespan ¶ added in v1.0.0
func (l *ListErrorsResponseBody) GetTimespan() []int64
type ListErrorsTimespan ¶ added in v1.0.0
type ListErrorsTimespan string
ListErrorsTimespan - This parameter specifies the time span between which the video views list should be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.
const ( ListErrorsTimespanSixtyminutes ListErrorsTimespan = "60:minutes" ListErrorsTimespanSixhours ListErrorsTimespan = "6:hours" ListErrorsTimespanTwentyFourhours ListErrorsTimespan = "24:hours" ListErrorsTimespanThreedays ListErrorsTimespan = "3:days" ListErrorsTimespanSevendays ListErrorsTimespan = "7:days" ListErrorsTimespanThirtydays ListErrorsTimespan = "30:days" )
func (ListErrorsTimespan) ToPointer ¶ added in v1.0.0
func (e ListErrorsTimespan) ToPointer() *ListErrorsTimespan
func (*ListErrorsTimespan) UnmarshalJSON ¶ added in v1.0.0
func (e *ListErrorsTimespan) UnmarshalJSON(data []byte) error
type ListFilterValuesForDimensionRequest ¶ added in v1.0.0
type ListFilterValuesForDimensionRequest struct {
// Pass Dimensions id
//
DimensionsID DimensionsID `pathParam:"style=simple,explode=false,name=dimensionsId"`
// This parameter specifies the time span between which the video views list should be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.
//
Timespan ListFilterValuesForDimensionTimespan `queryParam:"style=form,explode=true,name=timespan[]"`
// Pass the dimensions and their corresponding values you want to filter the views by. For excluding the values in the filter we can pass '!' before the filter value. The list of filters can be obtained from list of dimensions endpoint.
// Example Values : [ browser_name:Chrome , os_name:macOS , device_name:Galaxy ]
//
Filterby *string `queryParam:"style=form,explode=true,name=filterby[]"`
}
func (*ListFilterValuesForDimensionRequest) GetDimensionsID ¶ added in v1.0.0
func (l *ListFilterValuesForDimensionRequest) GetDimensionsID() DimensionsID
func (*ListFilterValuesForDimensionRequest) GetFilterby ¶ added in v1.0.0
func (l *ListFilterValuesForDimensionRequest) GetFilterby() *string
func (*ListFilterValuesForDimensionRequest) GetTimespan ¶ added in v1.0.0
func (l *ListFilterValuesForDimensionRequest) GetTimespan() ListFilterValuesForDimensionTimespan
type ListFilterValuesForDimensionResponse ¶ added in v1.0.0
type ListFilterValuesForDimensionResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Get filter / dimension value details by dimension name.
Object *ListFilterValuesForDimensionResponseBody
}
func (*ListFilterValuesForDimensionResponse) GetHTTPMeta ¶ added in v1.0.0
func (l *ListFilterValuesForDimensionResponse) GetHTTPMeta() components.HTTPMetadata
func (*ListFilterValuesForDimensionResponse) GetObject ¶ added in v1.0.0
func (l *ListFilterValuesForDimensionResponse) GetObject() *ListFilterValuesForDimensionResponseBody
type ListFilterValuesForDimensionResponseBody ¶ added in v1.0.0
type ListFilterValuesForDimensionResponseBody struct {
// It demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
// filter values associated with a specific dimension
Data []components.BrowserNameDimensiondetails `json:"data,omitempty"`
// The timeframe from and to details displayed in the form of unix epoch timestamps.
//
Timespan []int64 `json:"timespan,omitempty"`
}
ListFilterValuesForDimensionResponseBody - Get filter / dimension value details by dimension name.
func (*ListFilterValuesForDimensionResponseBody) GetData ¶ added in v1.0.0
func (l *ListFilterValuesForDimensionResponseBody) GetData() []components.BrowserNameDimensiondetails
func (*ListFilterValuesForDimensionResponseBody) GetSuccess ¶ added in v1.0.0
func (l *ListFilterValuesForDimensionResponseBody) GetSuccess() *bool
func (*ListFilterValuesForDimensionResponseBody) GetTimespan ¶ added in v1.0.0
func (l *ListFilterValuesForDimensionResponseBody) GetTimespan() []int64
type ListFilterValuesForDimensionTimespan ¶ added in v1.0.0
type ListFilterValuesForDimensionTimespan string
ListFilterValuesForDimensionTimespan - This parameter specifies the time span between which the video views list should be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.
const ( ListFilterValuesForDimensionTimespanSixtyminutes ListFilterValuesForDimensionTimespan = "60:minutes" ListFilterValuesForDimensionTimespanSixhours ListFilterValuesForDimensionTimespan = "6:hours" ListFilterValuesForDimensionTimespanTwentyFourhours ListFilterValuesForDimensionTimespan = "24:hours" ListFilterValuesForDimensionTimespanThreedays ListFilterValuesForDimensionTimespan = "3:days" ListFilterValuesForDimensionTimespanSevendays ListFilterValuesForDimensionTimespan = "7:days" ListFilterValuesForDimensionTimespanThirtydays ListFilterValuesForDimensionTimespan = "30:days" )
func (ListFilterValuesForDimensionTimespan) ToPointer ¶ added in v1.0.0
func (e ListFilterValuesForDimensionTimespan) ToPointer() *ListFilterValuesForDimensionTimespan
func (*ListFilterValuesForDimensionTimespan) UnmarshalJSON ¶ added in v1.0.0
func (e *ListFilterValuesForDimensionTimespan) UnmarshalJSON(data []byte) error
type ListLiveClipsRequest ¶ added in v1.0.0
type ListLiveClipsRequest struct {
// The stream Id is unique identifier assigned to the live stream.
LivestreamID string `pathParam:"style=simple,explode=false,name=livestreamId"`
// Limit specifies the maximum number of items to display per page.
Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
// Offset determines the starting point for data retrieval within a paginated list.
Offset *int64 `default:"1" queryParam:"style=form,explode=true,name=offset"`
// The values in the list can be arranged in two ways: DESC (Descending) or ASC (Ascending).
OrderBy *components.SortOrder `default:"desc" queryParam:"style=form,explode=true,name=orderBy"`
}
func (*ListLiveClipsRequest) GetLimit ¶ added in v1.0.0
func (l *ListLiveClipsRequest) GetLimit() *int64
func (*ListLiveClipsRequest) GetLivestreamID ¶ added in v1.0.0
func (l *ListLiveClipsRequest) GetLivestreamID() string
func (*ListLiveClipsRequest) GetOffset ¶ added in v1.0.0
func (l *ListLiveClipsRequest) GetOffset() *int64
func (*ListLiveClipsRequest) GetOrderBy ¶ added in v1.0.0
func (l *ListLiveClipsRequest) GetOrderBy() *components.SortOrder
func (ListLiveClipsRequest) MarshalJSON ¶ added in v1.0.0
func (l ListLiveClipsRequest) MarshalJSON() ([]byte, error)
func (*ListLiveClipsRequest) UnmarshalJSON ¶ added in v1.0.0
func (l *ListLiveClipsRequest) UnmarshalJSON(data []byte) error
type ListLiveClipsResponse ¶ added in v1.0.0
type ListLiveClipsResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// List of video media
Object *ListLiveClipsResponseBody
}
func (*ListLiveClipsResponse) GetHTTPMeta ¶ added in v1.0.0
func (l *ListLiveClipsResponse) GetHTTPMeta() components.HTTPMetadata
func (*ListLiveClipsResponse) GetObject ¶ added in v1.0.0
func (l *ListLiveClipsResponse) GetObject() *ListLiveClipsResponseBody
type ListLiveClipsResponseBody ¶ added in v1.0.0
type ListLiveClipsResponseBody struct {
// Demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
// Displays the result of the request.
Data []components.Media `json:"data,omitempty"`
// Pagination organizes content into pages for better readability and navigation.
Pagination *components.Pagination `json:"pagination,omitempty"`
}
ListLiveClipsResponseBody - List of video media
func (*ListLiveClipsResponseBody) GetData ¶ added in v1.0.0
func (l *ListLiveClipsResponseBody) GetData() []components.Media
func (*ListLiveClipsResponseBody) GetPagination ¶ added in v1.0.0
func (l *ListLiveClipsResponseBody) GetPagination() *components.Pagination
func (*ListLiveClipsResponseBody) GetSuccess ¶ added in v1.0.0
func (l *ListLiveClipsResponseBody) GetSuccess() *bool
type ListMediaRequest ¶
type ListMediaRequest struct {
// Limit specifies the maximum number of items to display per page.
Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
// Offset determines the starting point for data retrieval within a paginated list.
Offset *int64 `default:"1" queryParam:"style=form,explode=true,name=offset"`
// The values in the list can be arranged in two ways: DESC (Descending) or ASC (Ascending).
OrderBy *components.SortOrder `default:"desc" queryParam:"style=form,explode=true,name=orderBy"`
}
func (*ListMediaRequest) GetLimit ¶
func (l *ListMediaRequest) GetLimit() *int64
func (*ListMediaRequest) GetOffset ¶
func (l *ListMediaRequest) GetOffset() *int64
func (*ListMediaRequest) GetOrderBy ¶
func (l *ListMediaRequest) GetOrderBy() *components.SortOrder
func (ListMediaRequest) MarshalJSON ¶
func (l ListMediaRequest) MarshalJSON() ([]byte, error)
func (*ListMediaRequest) UnmarshalJSON ¶
func (l *ListMediaRequest) UnmarshalJSON(data []byte) error
type ListMediaResponse ¶
type ListMediaResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// List of video media
Object *ListMediaResponseBody
}
func (*ListMediaResponse) GetHTTPMeta ¶
func (l *ListMediaResponse) GetHTTPMeta() components.HTTPMetadata
func (*ListMediaResponse) GetObject ¶
func (l *ListMediaResponse) GetObject() *ListMediaResponseBody
type ListMediaResponseBody ¶
type ListMediaResponseBody struct {
// Demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
// Displays the result of the request.
Data []components.Media `json:"data,omitempty"`
// Pagination organizes content into pages for better readability and navigation.
Pagination *components.Pagination `json:"pagination,omitempty"`
}
ListMediaResponseBody - List of video media
func (*ListMediaResponseBody) GetData ¶
func (l *ListMediaResponseBody) GetData() []components.Media
func (*ListMediaResponseBody) GetPagination ¶
func (l *ListMediaResponseBody) GetPagination() *components.Pagination
func (*ListMediaResponseBody) GetSuccess ¶
func (l *ListMediaResponseBody) GetSuccess() *bool
type ListOverallValuesMetricID ¶ added in v1.0.0
type ListOverallValuesMetricID string
ListOverallValuesMetricID - Pass metric Id
const ( ListOverallValuesMetricIDViews ListOverallValuesMetricID = "views" ListOverallValuesMetricIDUniqueViewers ListOverallValuesMetricID = "unique_viewers" ListOverallValuesMetricIDPlayingTime ListOverallValuesMetricID = "playing_time" ListOverallValuesMetricIDQualityOfExperienceScore ListOverallValuesMetricID = "quality_of_experience_score" ListOverallValuesMetricIDPlaybackScore ListOverallValuesMetricID = "playback_score" ListOverallValuesMetricIDPlaybackFailurePercentage ListOverallValuesMetricID = "playback_failure_percentage" ListOverallValuesMetricIDExitBeforeVideoStart ListOverallValuesMetricID = "exit_before_video_start" ListOverallValuesMetricIDVideoStartupFailurePercentage ListOverallValuesMetricID = "video_startup_failure_percentage" ListOverallValuesMetricIDStartupScore ListOverallValuesMetricID = "startup_score" ListOverallValuesMetricIDVideoStartupTime ListOverallValuesMetricID = "video_startup_time" ListOverallValuesMetricIDPlayerStartupTime ListOverallValuesMetricID = "player_startup_time" ListOverallValuesMetricIDPageLoadTime ListOverallValuesMetricID = "page_load_time" ListOverallValuesMetricIDTotalStartupTime ListOverallValuesMetricID = "total_startup_time" ListOverallValuesMetricIDLiveStreamLatency ListOverallValuesMetricID = "live_stream_latency" ListOverallValuesMetricIDAverageBitrate ListOverallValuesMetricID = "average_bitrate" ListOverallValuesMetricIDBufferCount ListOverallValuesMetricID = "buffer_count" ListOverallValuesMetricIDRenderQualityScore ListOverallValuesMetricID = "render_quality_score" ListOverallValuesMetricIDAvgUpscaling ListOverallValuesMetricID = "avg_upscaling" ListOverallValuesMetricIDAvgDownscaling ListOverallValuesMetricID = "avg_downscaling" ListOverallValuesMetricIDMaxUpscaling ListOverallValuesMetricID = "max_upscaling" ListOverallValuesMetricIDMaxDownscaling ListOverallValuesMetricID = "max_downscaling" ListOverallValuesMetricIDJumpLatency ListOverallValuesMetricID = "jump_latency" ListOverallValuesMetricIDStabilityScore ListOverallValuesMetricID = "stability_score" ListOverallValuesMetricIDBufferRatio ListOverallValuesMetricID = "buffer_ratio" ListOverallValuesMetricIDBufferFrequency ListOverallValuesMetricID = "buffer_frequency" ListOverallValuesMetricIDBufferFill ListOverallValuesMetricID = "buffer_fill" )
func (ListOverallValuesMetricID) ToPointer ¶ added in v1.0.0
func (e ListOverallValuesMetricID) ToPointer() *ListOverallValuesMetricID
func (*ListOverallValuesMetricID) UnmarshalJSON ¶ added in v1.0.0
func (e *ListOverallValuesMetricID) UnmarshalJSON(data []byte) error
type ListOverallValuesRequest ¶ added in v1.0.0
type ListOverallValuesRequest struct {
// Pass metric Id
//
MetricID ListOverallValuesMetricID `pathParam:"style=simple,explode=false,name=metricId"`
// The measurement for the given metrics.
// Possible Values : [95th, median, avg, count or sum]
//
Measurement *string `default:"avg" queryParam:"style=form,explode=true,name=measurement"`
// This parameter specifies the time span between which the video views list should be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.
//
Timespan ListOverallValuesTimespan `queryParam:"style=form,explode=true,name=timespan[]"`
// Pass the dimensions and their corresponding values you want to filter the views by. For excluding the values in the filter we can pass '!' before the filter value. The list of filters can be obtained from list of dimensions endpoint.
// Example Values : [ browser_name:Chrome , os_name:macOS , device_name:Galaxy ]
//
Filterby *string `queryParam:"style=form,explode=true,name=filterby[]"`
}
func (*ListOverallValuesRequest) GetFilterby ¶ added in v1.0.0
func (l *ListOverallValuesRequest) GetFilterby() *string
func (*ListOverallValuesRequest) GetMeasurement ¶ added in v1.0.0
func (l *ListOverallValuesRequest) GetMeasurement() *string
func (*ListOverallValuesRequest) GetMetricID ¶ added in v1.0.0
func (l *ListOverallValuesRequest) GetMetricID() ListOverallValuesMetricID
func (*ListOverallValuesRequest) GetTimespan ¶ added in v1.0.0
func (l *ListOverallValuesRequest) GetTimespan() ListOverallValuesTimespan
func (ListOverallValuesRequest) MarshalJSON ¶ added in v1.0.0
func (l ListOverallValuesRequest) MarshalJSON() ([]byte, error)
func (*ListOverallValuesRequest) UnmarshalJSON ¶ added in v1.0.0
func (l *ListOverallValuesRequest) UnmarshalJSON(data []byte) error
type ListOverallValuesResponse ¶ added in v1.0.0
type ListOverallValuesResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Get filter/ dimension value details by dimension name.
Object *ListOverallValuesResponseBody
}
func (*ListOverallValuesResponse) GetHTTPMeta ¶ added in v1.0.0
func (l *ListOverallValuesResponse) GetHTTPMeta() components.HTTPMetadata
func (*ListOverallValuesResponse) GetObject ¶ added in v1.0.0
func (l *ListOverallValuesResponse) GetObject() *ListOverallValuesResponseBody
type ListOverallValuesResponseBody ¶ added in v1.0.0
type ListOverallValuesResponseBody struct {
// It demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
// Metadata that has to be paased for metric calculations.
MetaData *components.MetricsOverallMetaDataDetails `json:"metaData,omitempty"`
// Retrieves overall values for a specified metric
Data *components.MetricsOverallDataDetails `json:"data,omitempty"`
// The timeframe from and to details displayed in the form of unix epoch timestamps.
//
Timespan []int64 `json:"timespan,omitempty"`
}
ListOverallValuesResponseBody - Get filter/ dimension value details by dimension name.
func (*ListOverallValuesResponseBody) GetData ¶ added in v1.0.0
func (l *ListOverallValuesResponseBody) GetData() *components.MetricsOverallDataDetails
func (*ListOverallValuesResponseBody) GetMetaData ¶ added in v1.0.0
func (l *ListOverallValuesResponseBody) GetMetaData() *components.MetricsOverallMetaDataDetails
func (*ListOverallValuesResponseBody) GetSuccess ¶ added in v1.0.0
func (l *ListOverallValuesResponseBody) GetSuccess() *bool
func (*ListOverallValuesResponseBody) GetTimespan ¶ added in v1.0.0
func (l *ListOverallValuesResponseBody) GetTimespan() []int64
type ListOverallValuesTimespan ¶ added in v1.0.0
type ListOverallValuesTimespan string
ListOverallValuesTimespan - This parameter specifies the time span between which the video views list should be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.
const ( ListOverallValuesTimespanSixtyminutes ListOverallValuesTimespan = "60:minutes" ListOverallValuesTimespanSixhours ListOverallValuesTimespan = "6:hours" ListOverallValuesTimespanTwentyFourhours ListOverallValuesTimespan = "24:hours" ListOverallValuesTimespanThreedays ListOverallValuesTimespan = "3:days" ListOverallValuesTimespanSevendays ListOverallValuesTimespan = "7:days" ListOverallValuesTimespanThirtydays ListOverallValuesTimespan = "30:days" )
func (ListOverallValuesTimespan) ToPointer ¶ added in v1.0.0
func (e ListOverallValuesTimespan) ToPointer() *ListOverallValuesTimespan
func (*ListOverallValuesTimespan) UnmarshalJSON ¶ added in v1.0.0
func (e *ListOverallValuesTimespan) UnmarshalJSON(data []byte) error
type ListSigningKeysRequest ¶ added in v1.0.0
type ListSigningKeysRequest struct {
// Limit specifies the maximum number of items to display per page.
Limit *float64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
// It is used for pagination, indicating the starting point for fetching data.
Offset *float64 `default:"1" queryParam:"style=form,explode=true,name=offset"`
}
func (*ListSigningKeysRequest) GetLimit ¶ added in v1.0.0
func (l *ListSigningKeysRequest) GetLimit() *float64
func (*ListSigningKeysRequest) GetOffset ¶ added in v1.0.0
func (l *ListSigningKeysRequest) GetOffset() *float64
func (ListSigningKeysRequest) MarshalJSON ¶ added in v1.0.0
func (l ListSigningKeysRequest) MarshalJSON() ([]byte, error)
func (*ListSigningKeysRequest) UnmarshalJSON ¶ added in v1.0.0
func (l *ListSigningKeysRequest) UnmarshalJSON(data []byte) error
type ListSigningKeysResponse ¶ added in v1.0.0
type ListSigningKeysResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// successfully fetched all signing keys
GetAllSigningKeyResponse *components.GetAllSigningKeyResponse
}
func (*ListSigningKeysResponse) GetGetAllSigningKeyResponse ¶ added in v1.0.0
func (l *ListSigningKeysResponse) GetGetAllSigningKeyResponse() *components.GetAllSigningKeyResponse
func (*ListSigningKeysResponse) GetHTTPMeta ¶ added in v1.0.0
func (l *ListSigningKeysResponse) GetHTTPMeta() components.HTTPMetadata
type ListUploadsRequest ¶ added in v1.0.0
type ListUploadsRequest struct {
// Limit specifies the maximum number of items to display per page.
Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
// Offset determines the starting point for data retrieval within a paginated list.
Offset *int64 `default:"1" queryParam:"style=form,explode=true,name=offset"`
// The values in the list can be arranged in two ways: DESC (Descending) or ASC (Ascending).
OrderBy *components.SortOrder `default:"desc" queryParam:"style=form,explode=true,name=orderBy"`
}
func (*ListUploadsRequest) GetLimit ¶ added in v1.0.0
func (l *ListUploadsRequest) GetLimit() *int64
func (*ListUploadsRequest) GetOffset ¶ added in v1.0.0
func (l *ListUploadsRequest) GetOffset() *int64
func (*ListUploadsRequest) GetOrderBy ¶ added in v1.0.0
func (l *ListUploadsRequest) GetOrderBy() *components.SortOrder
func (ListUploadsRequest) MarshalJSON ¶ added in v1.0.0
func (l ListUploadsRequest) MarshalJSON() ([]byte, error)
func (*ListUploadsRequest) UnmarshalJSON ¶ added in v1.0.0
func (l *ListUploadsRequest) UnmarshalJSON(data []byte) error
type ListUploadsResponse ¶ added in v1.0.0
type ListUploadsResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// List of video media
Object *ListUploadsResponseBody
}
func (*ListUploadsResponse) GetHTTPMeta ¶ added in v1.0.0
func (l *ListUploadsResponse) GetHTTPMeta() components.HTTPMetadata
func (*ListUploadsResponse) GetObject ¶ added in v1.0.0
func (l *ListUploadsResponse) GetObject() *ListUploadsResponseBody
type ListUploadsResponseBody ¶ added in v1.0.0
type ListUploadsResponseBody struct {
// Demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
// Displays the result of the request.
Data []components.DirectUpload `json:"data,omitempty"`
// Pagination organizes content into pages for better readability and navigation.
Pagination *components.Pagination `json:"pagination,omitempty"`
}
ListUploadsResponseBody - List of video media
func (*ListUploadsResponseBody) GetData ¶ added in v1.0.0
func (l *ListUploadsResponseBody) GetData() []components.DirectUpload
func (*ListUploadsResponseBody) GetPagination ¶ added in v1.0.0
func (l *ListUploadsResponseBody) GetPagination() *components.Pagination
func (*ListUploadsResponseBody) GetSuccess ¶ added in v1.0.0
func (l *ListUploadsResponseBody) GetSuccess() *bool
type ListVideoViewsRequest ¶ added in v1.0.0
type ListVideoViewsRequest struct {
// This parameter specifies the time span between which the video views list should be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.
//
Timespan ListVideoViewsTimespan `queryParam:"style=form,explode=true,name=timespan[]"`
// Pass the dimensions and their corresponding values you want to filter the views by. For excluding the values in the filter we can pass '!' before the filter value. The list of filters can be obtained from list of dimensions endpoint.
// Example Values : [ browser_name:Chrome , os_name:macOS , device_name:Galaxy ]
//
Filterby *string `queryParam:"style=form,explode=true,name=filterby[]"`
// Pass the limit to display only the rows specified by the value.
//
Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
// Pass the offset value to indicate the page number.
//
Offset *int64 `default:"1" queryParam:"style=form,explode=true,name=offset"`
// Pass the viewer_id to filter the list of views. This value can be manually set during integration or generated by FastPix. When set manually it can be a string of aplha numeric values of any length.
//
ViewerID *string `queryParam:"style=form,explode=true,name=viewerId"`
// Pass the error code to filter the list of views. The possible values of error code can be fetched from list of errors end point.
//
ErrorCode optionalnullable.OptionalNullable[ErrorCode] `queryParam:"style=form,explode=true,name=errorCode"`
// Pass this value to sort the view list by.
//
OrderBy *string `default:"view_end" queryParam:"style=form,explode=true,name=orderBy"`
// The order direction to sort the view list by.
//
SortOrder *string `default:"asc" queryParam:"style=form,explode=true,name=sortOrder"`
}
func (*ListVideoViewsRequest) GetErrorCode ¶ added in v1.0.0
func (l *ListVideoViewsRequest) GetErrorCode() optionalnullable.OptionalNullable[ErrorCode]
func (*ListVideoViewsRequest) GetFilterby ¶ added in v1.0.0
func (l *ListVideoViewsRequest) GetFilterby() *string
func (*ListVideoViewsRequest) GetLimit ¶ added in v1.0.0
func (l *ListVideoViewsRequest) GetLimit() *int64
func (*ListVideoViewsRequest) GetOffset ¶ added in v1.0.0
func (l *ListVideoViewsRequest) GetOffset() *int64
func (*ListVideoViewsRequest) GetOrderBy ¶ added in v1.0.0
func (l *ListVideoViewsRequest) GetOrderBy() *string
func (*ListVideoViewsRequest) GetSortOrder ¶ added in v1.0.0
func (l *ListVideoViewsRequest) GetSortOrder() *string
func (*ListVideoViewsRequest) GetTimespan ¶ added in v1.0.0
func (l *ListVideoViewsRequest) GetTimespan() ListVideoViewsTimespan
func (*ListVideoViewsRequest) GetViewerID ¶ added in v1.0.0
func (l *ListVideoViewsRequest) GetViewerID() *string
func (ListVideoViewsRequest) MarshalJSON ¶ added in v1.0.0
func (l ListVideoViewsRequest) MarshalJSON() ([]byte, error)
func (*ListVideoViewsRequest) UnmarshalJSON ¶ added in v1.0.0
func (l *ListVideoViewsRequest) UnmarshalJSON(data []byte) error
type ListVideoViewsResponse ¶ added in v1.0.0
type ListVideoViewsResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Get the list of Views
Object *ListVideoViewsResponseBody
}
func (*ListVideoViewsResponse) GetHTTPMeta ¶ added in v1.0.0
func (l *ListVideoViewsResponse) GetHTTPMeta() components.HTTPMetadata
func (*ListVideoViewsResponse) GetObject ¶ added in v1.0.0
func (l *ListVideoViewsResponse) GetObject() *ListVideoViewsResponseBody
type ListVideoViewsResponseBody ¶ added in v1.0.0
type ListVideoViewsResponseBody struct {
// It demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
// Displays the result of the request.
Data []components.ViewsList `json:"data,omitempty"`
// Pagination organizes content into pages for better readability and navigation.
Pagination *components.DataPagination `json:"pagination,omitempty"`
// The timeframe from and to details displayed in the form of unix epoch timestamps.
//
Timespan []int64 `json:"timespan,omitempty"`
}
ListVideoViewsResponseBody - Get the list of Views
func (*ListVideoViewsResponseBody) GetData ¶ added in v1.0.0
func (l *ListVideoViewsResponseBody) GetData() []components.ViewsList
func (*ListVideoViewsResponseBody) GetPagination ¶ added in v1.0.0
func (l *ListVideoViewsResponseBody) GetPagination() *components.DataPagination
func (*ListVideoViewsResponseBody) GetSuccess ¶ added in v1.0.0
func (l *ListVideoViewsResponseBody) GetSuccess() *bool
func (*ListVideoViewsResponseBody) GetTimespan ¶ added in v1.0.0
func (l *ListVideoViewsResponseBody) GetTimespan() []int64
type ListVideoViewsTimespan ¶ added in v1.0.0
type ListVideoViewsTimespan string
ListVideoViewsTimespan - This parameter specifies the time span between which the video views list should be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.
const ( ListVideoViewsTimespanSixtyminutes ListVideoViewsTimespan = "60:minutes" ListVideoViewsTimespanSixhours ListVideoViewsTimespan = "6:hours" ListVideoViewsTimespanTwentyFourhours ListVideoViewsTimespan = "24:hours" ListVideoViewsTimespanThreedays ListVideoViewsTimespan = "3:days" ListVideoViewsTimespanSevendays ListVideoViewsTimespan = "7:days" ListVideoViewsTimespanThirtydays ListVideoViewsTimespan = "30:days" )
func (ListVideoViewsTimespan) ToPointer ¶ added in v1.0.0
func (e ListVideoViewsTimespan) ToPointer() *ListVideoViewsTimespan
func (*ListVideoViewsTimespan) UnmarshalJSON ¶ added in v1.0.0
func (e *ListVideoViewsTimespan) UnmarshalJSON(data []byte) error
type MaxResolution ¶
type MaxResolution string
MaxResolution - Determines the highest quality resolution available.
const ( MaxResolutionTwoThousandOneHundredAndSixtyp MaxResolution = "2160p" MaxResolutionOneThousandFourHundredAndFortyp MaxResolution = "1440p" MaxResolutionOneThousandAndEightyp MaxResolution = "1080p" MaxResolutionSevenHundredAndTwentyp MaxResolution = "720p" MaxResolutionFourHundredAndEightyp MaxResolution = "480p" MaxResolutionThreeHundredAndSixtyp MaxResolution = "360p" )
func (MaxResolution) ToPointer ¶
func (e MaxResolution) ToPointer() *MaxResolution
func (*MaxResolution) UnmarshalJSON ¶
func (e *MaxResolution) UnmarshalJSON(data []byte) error
type Option ¶
func WithOperationTimeout ¶
WithOperationTimeout allows setting the request timeout applied for an operation.
func WithRetries ¶
WithRetries allows customizing the default retry configuration.
func WithServerURL ¶
WithServerURL allows providing an alternative server URL.
func WithSetHeaders ¶
WithSetHeaders takes a map of headers that will applied to a request. If the request contains headers that are in the map then they will be overwritten.
func WithTemplatedServerURL ¶
WithTemplatedServerURL allows providing an alternative server URL with templated parameters.
func WithURLOverride ¶
WithURLOverride allows overriding the URL.
type OrderBy ¶ added in v1.0.0
type OrderBy string
OrderBy - The list of value can be order in two ways DESC (Descending) or ASC (Ascending). In case not specified, by default it will be DESC.
func (*OrderBy) UnmarshalJSON ¶ added in v1.0.0
type PushMediaSettings ¶
type PushMediaSettings struct {
// Basic access policy for media content
AccessPolicy components.BasicAccessPolicy `json:"accessPolicy"`
// Start time indicates where encoding should begin within the video file, in seconds.
StartTime *float64 `json:"startTime,omitempty"`
// End time indicates where encoding should end within the video file, in seconds.
EndTime *float64 `json:"endTime,omitempty"`
Inputs []Input `json:"inputs,omitempty"`
// Tag a video in "key" : "value" pairs for searchable metadata. Maximum 10 entries, 255 characters each.
Metadata map[string]string `json:"metadata,omitempty"`
// Generates subtitle files for audio/video files.
//
Subtitles *Subtitles `json:"subtitles,omitempty"`
// Enhance the quality and volume of the audio track. This is available for pre-recorded content only.
//
OptimizeAudio *bool `default:"true" json:"optimizeAudio"`
// Determines the highest quality resolution available.
//
MaxResolution *MaxResolution `default:"1080p" json:"maxResolution"`
// 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"`
// Generates MP4 video up to 4K ("capped_4k"), m4a audio only ("audioOnly"), or both for offline viewing.
//
Mp4Support *DirectUploadVideoMediaMp4Support `json:"mp4Support,omitempty"`
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 *DirectUploadVideoMediaModeration `json:"moderation,omitempty"`
AccessRestrictions *DirectUploadVideoMediaAccessRestrictions `json:"accessRestrictions,omitempty"`
}
PushMediaSettings - Configuration settings for media upload.
func (*PushMediaSettings) GetAccessPolicy ¶
func (p *PushMediaSettings) GetAccessPolicy() components.BasicAccessPolicy
func (*PushMediaSettings) GetAccessRestrictions ¶
func (p *PushMediaSettings) GetAccessRestrictions() *DirectUploadVideoMediaAccessRestrictions
func (*PushMediaSettings) GetChapters ¶
func (p *PushMediaSettings) GetChapters() *bool
func (*PushMediaSettings) GetEndTime ¶
func (p *PushMediaSettings) GetEndTime() *float64
func (*PushMediaSettings) GetInputs ¶
func (p *PushMediaSettings) GetInputs() []Input
func (*PushMediaSettings) GetMaxResolution ¶
func (p *PushMediaSettings) GetMaxResolution() *MaxResolution
func (*PushMediaSettings) GetMetadata ¶
func (p *PushMediaSettings) GetMetadata() map[string]string
func (*PushMediaSettings) GetModeration ¶
func (p *PushMediaSettings) GetModeration() *DirectUploadVideoMediaModeration
func (*PushMediaSettings) GetMp4Support ¶
func (p *PushMediaSettings) GetMp4Support() *DirectUploadVideoMediaMp4Support
func (*PushMediaSettings) GetNamedEntities ¶
func (p *PushMediaSettings) GetNamedEntities() *bool
func (*PushMediaSettings) GetOptimizeAudio ¶
func (p *PushMediaSettings) GetOptimizeAudio() *bool
func (*PushMediaSettings) GetSourceAccess ¶
func (p *PushMediaSettings) GetSourceAccess() *bool
func (*PushMediaSettings) GetStartTime ¶
func (p *PushMediaSettings) GetStartTime() *float64
func (*PushMediaSettings) GetSubtitles ¶
func (p *PushMediaSettings) GetSubtitles() *Subtitles
func (*PushMediaSettings) GetSummary ¶
func (p *PushMediaSettings) GetSummary() *Summary
func (PushMediaSettings) MarshalJSON ¶
func (p PushMediaSettings) MarshalJSON() ([]byte, error)
func (*PushMediaSettings) UnmarshalJSON ¶
func (p *PushMediaSettings) UnmarshalJSON(data []byte) error
type Resolution ¶ added in v1.0.0
type Resolution string
Resolution - The maximum resolution for the playback ID.
const ( ResolutionFourHundredAndEightyp Resolution = "480p" ResolutionSevenHundredAndTwentyp Resolution = "720p" ResolutionOneThousandAndEightyp Resolution = "1080p" ResolutionOneThousandFourHundredAndFortyp Resolution = "1440p" ResolutionTwoThousandOneHundredAndSixtyp Resolution = "2160p" )
func (Resolution) ToPointer ¶ added in v1.0.0
func (e Resolution) ToPointer() *Resolution
func (*Resolution) UnmarshalJSON ¶ added in v1.0.0
func (e *Resolution) UnmarshalJSON(data []byte) error
type RetrieveMediaInputInfoData ¶ added in v1.0.0
type RetrieveMediaInputInfoData struct {
}
RetrieveMediaInputInfoData - Displays the result of the request.
type RetrieveMediaInputInfoRequest ¶
type RetrieveMediaInputInfoRequest struct {
// Pass the list of the input objects used to create the media, along with applied settings.
MediaID string `pathParam:"style=simple,explode=false,name=mediaId"`
}
func (*RetrieveMediaInputInfoRequest) GetMediaID ¶
func (r *RetrieveMediaInputInfoRequest) GetMediaID() string
type RetrieveMediaInputInfoResponse ¶
type RetrieveMediaInputInfoResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Get video media input information
Object *RetrieveMediaInputInfoResponseBody
}
func (*RetrieveMediaInputInfoResponse) GetHTTPMeta ¶
func (r *RetrieveMediaInputInfoResponse) GetHTTPMeta() components.HTTPMetadata
func (*RetrieveMediaInputInfoResponse) GetObject ¶
func (r *RetrieveMediaInputInfoResponse) GetObject() *RetrieveMediaInputInfoResponseBody
type RetrieveMediaInputInfoResponseBody ¶
type RetrieveMediaInputInfoResponseBody struct {
// Demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
// Displays the result of the request.
Data *RetrieveMediaInputInfoData `json:"data,omitempty"`
}
RetrieveMediaInputInfoResponseBody - Get video media input information
func (*RetrieveMediaInputInfoResponseBody) GetData ¶
func (r *RetrieveMediaInputInfoResponseBody) GetData() *RetrieveMediaInputInfoData
func (*RetrieveMediaInputInfoResponseBody) GetSuccess ¶
func (r *RetrieveMediaInputInfoResponseBody) GetSuccess() *bool
type Subtitles ¶
type Subtitles struct {
// Name of the language for the subtitles.
LanguageName *string `json:"languageName,omitempty"`
// Tag a video in "key" : "value" pairs for searchable metadata. Maximum 10 entries, 255 characters each.
Metadata map[string]string `json:"metadata,omitempty"`
// Language codes (BCP 47 compliant) used for text files.
//
LanguageCode *LanguageCode `json:"languageCode,omitempty"`
}
Subtitles - Generates subtitle files for audio/video files.
func (*Subtitles) GetLanguageCode ¶
func (s *Subtitles) GetLanguageCode() *LanguageCode
func (*Subtitles) GetLanguageName ¶
func (*Subtitles) GetMetadata ¶
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,omitempty"`
// 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 (*Summary) GetSummaryLength ¶
func (Summary) MarshalJSON ¶
func (*Summary) UnmarshalJSON ¶
type UpdateAPlaylistRequest ¶ added in v1.0.0
type UpdateAPlaylistRequest struct {
// The unique id of the playlist you want to retrieve.
PlaylistID string `pathParam:"style=simple,explode=false,name=playlistId"`
UpdatePlaylistRequest components.UpdatePlaylistRequest `request:"mediaType=application/json"`
}
func (*UpdateAPlaylistRequest) GetPlaylistID ¶ added in v1.0.0
func (u *UpdateAPlaylistRequest) GetPlaylistID() string
func (*UpdateAPlaylistRequest) GetUpdatePlaylistRequest ¶ added in v1.0.0
func (u *UpdateAPlaylistRequest) GetUpdatePlaylistRequest() components.UpdatePlaylistRequest
type UpdateAPlaylistResponse ¶ added in v1.0.0
type UpdateAPlaylistResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Playlist updated successfully
PlaylistCreatedResponse *components.PlaylistCreatedResponse
}
func (*UpdateAPlaylistResponse) GetHTTPMeta ¶ added in v1.0.0
func (u *UpdateAPlaylistResponse) GetHTTPMeta() components.HTTPMetadata
func (*UpdateAPlaylistResponse) GetPlaylistCreatedResponse ¶ added in v1.0.0
func (u *UpdateAPlaylistResponse) GetPlaylistCreatedResponse() *components.PlaylistCreatedResponse
type UpdateLiveStreamRequest ¶
type UpdateLiveStreamRequest struct {
// Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
StreamID string `pathParam:"style=simple,explode=false,name=streamId"`
PatchLiveStreamRequest components.PatchLiveStreamRequest `request:"mediaType=application/json"`
}
func (*UpdateLiveStreamRequest) GetPatchLiveStreamRequest ¶
func (u *UpdateLiveStreamRequest) GetPatchLiveStreamRequest() components.PatchLiveStreamRequest
func (*UpdateLiveStreamRequest) GetStreamID ¶
func (u *UpdateLiveStreamRequest) GetStreamID() string
type UpdateLiveStreamResponse ¶
type UpdateLiveStreamResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Stream details updated successfully
PatchResponseDTO *components.PatchResponseDTO
}
func (*UpdateLiveStreamResponse) GetHTTPMeta ¶
func (u *UpdateLiveStreamResponse) GetHTTPMeta() components.HTTPMetadata
func (*UpdateLiveStreamResponse) GetPatchResponseDTO ¶
func (u *UpdateLiveStreamResponse) GetPatchResponseDTO() *components.PatchResponseDTO
type UpdateMediaChaptersRequest ¶ added in v1.0.0
type UpdateMediaChaptersRequest struct {
// The unique identifier assigned to the media when created. The value should be a valid UUID.
//
MediaID string `pathParam:"style=simple,explode=false,name=mediaId"`
RequestBody UpdateMediaChaptersRequestBody `request:"mediaType=application/json"`
}
func (*UpdateMediaChaptersRequest) GetMediaID ¶ added in v1.0.0
func (u *UpdateMediaChaptersRequest) GetMediaID() string
func (*UpdateMediaChaptersRequest) GetRequestBody ¶ added in v1.0.0
func (u *UpdateMediaChaptersRequest) GetRequestBody() UpdateMediaChaptersRequestBody
type UpdateMediaChaptersRequestBody ¶ added in v1.0.0
type UpdateMediaChaptersRequestBody struct {
// Enable or disable the chapters feature for the media. Set to `true` to enable chapters or `false` to disable.
//
Chapters bool `json:"chapters"`
}
func (*UpdateMediaChaptersRequestBody) GetChapters ¶ added in v1.0.0
func (u *UpdateMediaChaptersRequestBody) GetChapters() bool
type UpdateMediaChaptersResponse ¶ added in v1.0.0
type UpdateMediaChaptersResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Media details updated successfully with the chapters feature enabled or disabled
Object *UpdateMediaChaptersResponseBody
}
func (*UpdateMediaChaptersResponse) GetHTTPMeta ¶ added in v1.0.0
func (u *UpdateMediaChaptersResponse) GetHTTPMeta() components.HTTPMetadata
func (*UpdateMediaChaptersResponse) GetObject ¶ added in v1.0.0
func (u *UpdateMediaChaptersResponse) GetObject() *UpdateMediaChaptersResponseBody
type UpdateMediaChaptersResponseBody ¶ added in v1.0.0
type UpdateMediaChaptersResponseBody struct {
// Indicates if the request was successful or not.
Success *bool `json:"success,omitempty"`
Data *components.ChaptersResponse `json:"data,omitempty"`
}
UpdateMediaChaptersResponseBody - Media details updated successfully with the chapters feature enabled or disabled
func (*UpdateMediaChaptersResponseBody) GetData ¶ added in v1.0.0
func (u *UpdateMediaChaptersResponseBody) GetData() *components.ChaptersResponse
func (*UpdateMediaChaptersResponseBody) GetSuccess ¶ added in v1.0.0
func (u *UpdateMediaChaptersResponseBody) GetSuccess() *bool
type UpdateMediaModerationModeration ¶ added in v1.0.0
type UpdateMediaModerationModeration struct {
// Type of media content
Type *components.MediaType `json:"type,omitempty"`
}
func (*UpdateMediaModerationModeration) GetType ¶ added in v1.0.0
func (u *UpdateMediaModerationModeration) GetType() *components.MediaType
type UpdateMediaModerationRequest ¶ added in v1.0.0
type UpdateMediaModerationRequest struct {
// The unique identifier assigned to the media when created. The value should be a valid UUID.
//
MediaID string `pathParam:"style=simple,explode=false,name=mediaId"`
RequestBody UpdateMediaModerationRequestBody `request:"mediaType=application/json"`
}
func (*UpdateMediaModerationRequest) GetMediaID ¶ added in v1.0.0
func (u *UpdateMediaModerationRequest) GetMediaID() string
func (*UpdateMediaModerationRequest) GetRequestBody ¶ added in v1.0.0
func (u *UpdateMediaModerationRequest) GetRequestBody() UpdateMediaModerationRequestBody
type UpdateMediaModerationRequestBody ¶ added in v1.0.0
type UpdateMediaModerationRequestBody struct {
Moderation *UpdateMediaModerationModeration `json:"moderation,omitempty"`
}
func (*UpdateMediaModerationRequestBody) GetModeration ¶ added in v1.0.0
func (u *UpdateMediaModerationRequestBody) GetModeration() *UpdateMediaModerationModeration
type UpdateMediaModerationResponse ¶ added in v1.0.0
type UpdateMediaModerationResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Media details updated successfully with the named entity extraction feature enabled or disabled
Object *UpdateMediaModerationResponseBody
}
func (*UpdateMediaModerationResponse) GetHTTPMeta ¶ added in v1.0.0
func (u *UpdateMediaModerationResponse) GetHTTPMeta() components.HTTPMetadata
func (*UpdateMediaModerationResponse) GetObject ¶ added in v1.0.0
func (u *UpdateMediaModerationResponse) GetObject() *UpdateMediaModerationResponseBody
type UpdateMediaModerationResponseBody ¶ added in v1.0.0
type UpdateMediaModerationResponseBody struct {
// Indicates if the request was successful or not.
Success *bool `json:"success,omitempty"`
Data *components.ModerationResponse `json:"data,omitempty"`
}
UpdateMediaModerationResponseBody - Media details updated successfully with the named entity extraction feature enabled or disabled
func (*UpdateMediaModerationResponseBody) GetData ¶ added in v1.0.0
func (u *UpdateMediaModerationResponseBody) GetData() *components.ModerationResponse
func (*UpdateMediaModerationResponseBody) GetSuccess ¶ added in v1.0.0
func (u *UpdateMediaModerationResponseBody) GetSuccess() *bool
type UpdateMediaNamedEntitiesRequest ¶ added in v1.0.0
type UpdateMediaNamedEntitiesRequest struct {
// The unique identifier assigned to the media when created. The value should be a valid UUID.
//
MediaID string `pathParam:"style=simple,explode=false,name=mediaId"`
RequestBody UpdateMediaNamedEntitiesRequestBody `request:"mediaType=application/json"`
}
func (*UpdateMediaNamedEntitiesRequest) GetMediaID ¶ added in v1.0.0
func (u *UpdateMediaNamedEntitiesRequest) GetMediaID() string
func (*UpdateMediaNamedEntitiesRequest) GetRequestBody ¶ added in v1.0.0
func (u *UpdateMediaNamedEntitiesRequest) GetRequestBody() UpdateMediaNamedEntitiesRequestBody
type UpdateMediaNamedEntitiesRequestBody ¶ added in v1.0.0
type UpdateMediaNamedEntitiesRequestBody struct {
// Enable or disable named entity extraction. Set to `true` to enable or `false` to disable.
//
NamedEntities bool `json:"namedEntities"`
}
func (*UpdateMediaNamedEntitiesRequestBody) GetNamedEntities ¶ added in v1.0.0
func (u *UpdateMediaNamedEntitiesRequestBody) GetNamedEntities() bool
type UpdateMediaNamedEntitiesResponse ¶ added in v1.0.0
type UpdateMediaNamedEntitiesResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Media details updated successfully with the named entity extraction feature enabled or disabled
Object *UpdateMediaNamedEntitiesResponseBody
}
func (*UpdateMediaNamedEntitiesResponse) GetHTTPMeta ¶ added in v1.0.0
func (u *UpdateMediaNamedEntitiesResponse) GetHTTPMeta() components.HTTPMetadata
func (*UpdateMediaNamedEntitiesResponse) GetObject ¶ added in v1.0.0
func (u *UpdateMediaNamedEntitiesResponse) GetObject() *UpdateMediaNamedEntitiesResponseBody
type UpdateMediaNamedEntitiesResponseBody ¶ added in v1.0.0
type UpdateMediaNamedEntitiesResponseBody struct {
// Indicates if the request was successful or not.
Success *bool `json:"success,omitempty"`
Data *components.NamedEntitiesResponse `json:"data,omitempty"`
}
UpdateMediaNamedEntitiesResponseBody - Media details updated successfully with the named entity extraction feature enabled or disabled
func (*UpdateMediaNamedEntitiesResponseBody) GetData ¶ added in v1.0.0
func (u *UpdateMediaNamedEntitiesResponseBody) GetData() *components.NamedEntitiesResponse
func (*UpdateMediaNamedEntitiesResponseBody) GetSuccess ¶ added in v1.0.0
func (u *UpdateMediaNamedEntitiesResponseBody) GetSuccess() *bool
type UpdateMediaSummaryRequest ¶ added in v1.0.0
type UpdateMediaSummaryRequest struct {
// The unique identifier assigned to the media when created. The value should be a valid UUID.
//
MediaID string `pathParam:"style=simple,explode=false,name=mediaId"`
RequestBody UpdateMediaSummaryRequestBody `request:"mediaType=application/json"`
}
func (*UpdateMediaSummaryRequest) GetMediaID ¶ added in v1.0.0
func (u *UpdateMediaSummaryRequest) GetMediaID() string
func (*UpdateMediaSummaryRequest) GetRequestBody ¶ added in v1.0.0
func (u *UpdateMediaSummaryRequest) GetRequestBody() UpdateMediaSummaryRequestBody
type UpdateMediaSummaryRequestBody ¶ added in v1.0.0
type UpdateMediaSummaryRequestBody 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 (*UpdateMediaSummaryRequestBody) GetGenerate ¶ added in v1.0.0
func (u *UpdateMediaSummaryRequestBody) GetGenerate() bool
func (*UpdateMediaSummaryRequestBody) GetSummaryLength ¶ added in v1.0.0
func (u *UpdateMediaSummaryRequestBody) GetSummaryLength() *int64
func (UpdateMediaSummaryRequestBody) MarshalJSON ¶ added in v1.0.0
func (u UpdateMediaSummaryRequestBody) MarshalJSON() ([]byte, error)
func (*UpdateMediaSummaryRequestBody) UnmarshalJSON ¶ added in v1.0.0
func (u *UpdateMediaSummaryRequestBody) UnmarshalJSON(data []byte) error
type UpdateMediaSummaryResponse ¶ added in v1.0.0
type UpdateMediaSummaryResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Media details updated successfully with the generated summary
Object *UpdateMediaSummaryResponseBody
}
func (*UpdateMediaSummaryResponse) GetHTTPMeta ¶ added in v1.0.0
func (u *UpdateMediaSummaryResponse) GetHTTPMeta() components.HTTPMetadata
func (*UpdateMediaSummaryResponse) GetObject ¶ added in v1.0.0
func (u *UpdateMediaSummaryResponse) GetObject() *UpdateMediaSummaryResponseBody
type UpdateMediaSummaryResponseBody ¶ added in v1.0.0
type UpdateMediaSummaryResponseBody struct {
// Indicates if the request was successful or not.
Success *bool `json:"success,omitempty"`
Data *components.SummaryResponse `json:"data,omitempty"`
}
UpdateMediaSummaryResponseBody - Media details updated successfully with the generated summary
func (*UpdateMediaSummaryResponseBody) GetData ¶ added in v1.0.0
func (u *UpdateMediaSummaryResponseBody) GetData() *components.SummaryResponse
func (*UpdateMediaSummaryResponseBody) GetSuccess ¶ added in v1.0.0
func (u *UpdateMediaSummaryResponseBody) GetSuccess() *bool
type UpdateMediaTrackRequest ¶ added in v1.0.0
type UpdateMediaTrackRequest struct {
// When creating the media, FastPix assigns a universally unique identifier with a maximum length of 255 characters.
TrackID string `pathParam:"style=simple,explode=false,name=trackId"`
// When creating the media, FastPix assigns a universally unique identifier with a maximum length of 255 characters.
MediaID string `pathParam:"style=simple,explode=false,name=mediaId"`
UpdateTrackRequest components.UpdateTrackRequest `request:"mediaType=application/json"`
}
func (*UpdateMediaTrackRequest) GetMediaID ¶ added in v1.0.0
func (u *UpdateMediaTrackRequest) GetMediaID() string
func (*UpdateMediaTrackRequest) GetTrackID ¶ added in v1.0.0
func (u *UpdateMediaTrackRequest) GetTrackID() string
func (*UpdateMediaTrackRequest) GetUpdateTrackRequest ¶ added in v1.0.0
func (u *UpdateMediaTrackRequest) GetUpdateTrackRequest() components.UpdateTrackRequest
type UpdateMediaTrackResponse ¶ added in v1.0.0
type UpdateMediaTrackResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Media details updated successfully
Object *UpdateMediaTrackResponseBody
}
func (*UpdateMediaTrackResponse) GetHTTPMeta ¶ added in v1.0.0
func (u *UpdateMediaTrackResponse) GetHTTPMeta() components.HTTPMetadata
func (*UpdateMediaTrackResponse) GetObject ¶ added in v1.0.0
func (u *UpdateMediaTrackResponse) GetObject() *UpdateMediaTrackResponseBody
type UpdateMediaTrackResponseBody ¶ added in v1.0.0
type UpdateMediaTrackResponseBody struct {
// Demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
// Contains details about the track that was added or updated.
Data *components.UpdateTrackResponse `json:"data,omitempty"`
}
UpdateMediaTrackResponseBody - Media details updated successfully
func (*UpdateMediaTrackResponseBody) GetData ¶ added in v1.0.0
func (u *UpdateMediaTrackResponseBody) GetData() *components.UpdateTrackResponse
func (*UpdateMediaTrackResponseBody) GetSuccess ¶ added in v1.0.0
func (u *UpdateMediaTrackResponseBody) GetSuccess() *bool
type UpdateSpecificSimulcastOfStreamRequest ¶
type UpdateSpecificSimulcastOfStreamRequest struct {
// Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
StreamID string `pathParam:"style=simple,explode=false,name=streamId"`
// When you create the new simulcast, FastPix assign a universal unique identifier which can contain a maximum of 255 characters.
SimulcastID string `pathParam:"style=simple,explode=false,name=simulcastId"`
SimulcastUpdateRequest components.SimulcastUpdateRequest `request:"mediaType=application/json"`
}
func (*UpdateSpecificSimulcastOfStreamRequest) GetSimulcastID ¶
func (u *UpdateSpecificSimulcastOfStreamRequest) GetSimulcastID() string
func (*UpdateSpecificSimulcastOfStreamRequest) GetSimulcastUpdateRequest ¶
func (u *UpdateSpecificSimulcastOfStreamRequest) GetSimulcastUpdateRequest() components.SimulcastUpdateRequest
func (*UpdateSpecificSimulcastOfStreamRequest) GetStreamID ¶
func (u *UpdateSpecificSimulcastOfStreamRequest) GetStreamID() string
type UpdateSpecificSimulcastOfStreamResponse ¶
type UpdateSpecificSimulcastOfStreamResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Stream's simulcast details fetched successfully
SimulcastUpdateResponse *components.SimulcastUpdateResponse
}
func (*UpdateSpecificSimulcastOfStreamResponse) GetHTTPMeta ¶
func (u *UpdateSpecificSimulcastOfStreamResponse) GetHTTPMeta() components.HTTPMetadata
func (*UpdateSpecificSimulcastOfStreamResponse) GetSimulcastUpdateResponse ¶
func (u *UpdateSpecificSimulcastOfStreamResponse) GetSimulcastUpdateResponse() *components.SimulcastUpdateResponse
type UpdatedMediaRequest ¶
type UpdatedMediaRequest struct {
// When creating the media, FastPix assigns a universally unique identifier with a maximum length of 255 characters.
MediaID string `pathParam:"style=simple,explode=false,name=mediaId"`
RequestBody UpdatedMediaRequestBody `request:"mediaType=application/json"`
}
func (*UpdatedMediaRequest) GetMediaID ¶
func (u *UpdatedMediaRequest) GetMediaID() string
func (*UpdatedMediaRequest) GetRequestBody ¶
func (u *UpdatedMediaRequest) GetRequestBody() UpdatedMediaRequestBody
type UpdatedMediaRequestBody ¶
func (*UpdatedMediaRequestBody) GetMetadata ¶
func (u *UpdatedMediaRequestBody) GetMetadata() map[string]string
type UpdatedMediaResponse ¶
type UpdatedMediaResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Media details updated successfully
Object *UpdatedMediaResponseBody
}
func (*UpdatedMediaResponse) GetHTTPMeta ¶
func (u *UpdatedMediaResponse) GetHTTPMeta() components.HTTPMetadata
func (*UpdatedMediaResponse) GetObject ¶
func (u *UpdatedMediaResponse) GetObject() *UpdatedMediaResponseBody
type UpdatedMediaResponseBody ¶
type UpdatedMediaResponseBody struct {
// Demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
Data *components.Media `json:"data,omitempty"`
}
UpdatedMediaResponseBody - Media details updated successfully
func (*UpdatedMediaResponseBody) GetData ¶
func (u *UpdatedMediaResponseBody) GetData() *components.Media
func (*UpdatedMediaResponseBody) GetSuccess ¶
func (u *UpdatedMediaResponseBody) GetSuccess() *bool
type UpdatedMp4SupportMp4Support ¶ added in v1.0.0
type UpdatedMp4SupportMp4Support string
UpdatedMp4SupportMp4Support - 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 ( UpdatedMp4SupportMp4SupportNone UpdatedMp4SupportMp4Support = "none" UpdatedMp4SupportMp4SupportCapped4k UpdatedMp4SupportMp4Support = "capped_4k" UpdatedMp4SupportMp4SupportAudioOnly UpdatedMp4SupportMp4Support = "audioOnly" UpdatedMp4SupportMp4SupportAudioOnlyCapped4k UpdatedMp4SupportMp4Support = "audioOnly,capped_4k" )
func (UpdatedMp4SupportMp4Support) ToPointer ¶ added in v1.0.0
func (e UpdatedMp4SupportMp4Support) ToPointer() *UpdatedMp4SupportMp4Support
func (*UpdatedMp4SupportMp4Support) UnmarshalJSON ¶ added in v1.0.0
func (e *UpdatedMp4SupportMp4Support) UnmarshalJSON(data []byte) error
type UpdatedMp4SupportRequest ¶ added in v1.0.0
type UpdatedMp4SupportRequest struct {
// When creating the media, FastPix assigns a universally unique identifier with a maximum length of 255 characters.
//
MediaID string `pathParam:"style=simple,explode=false,name=mediaId"`
RequestBody UpdatedMp4SupportRequestBody `request:"mediaType=application/json"`
}
func (*UpdatedMp4SupportRequest) GetMediaID ¶ added in v1.0.0
func (u *UpdatedMp4SupportRequest) GetMediaID() string
func (*UpdatedMp4SupportRequest) GetRequestBody ¶ added in v1.0.0
func (u *UpdatedMp4SupportRequest) GetRequestBody() UpdatedMp4SupportRequestBody
type UpdatedMp4SupportRequestBody ¶ added in v1.0.0
type UpdatedMp4SupportRequestBody struct {
// 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 *UpdatedMp4SupportMp4Support `json:"mp4Support,omitempty"`
}
func (*UpdatedMp4SupportRequestBody) GetMp4Support ¶ added in v1.0.0
func (u *UpdatedMp4SupportRequestBody) GetMp4Support() *UpdatedMp4SupportMp4Support
type UpdatedMp4SupportResponse ¶ added in v1.0.0
type UpdatedMp4SupportResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Media details updated successfully
Object *UpdatedMp4SupportResponseBody
}
func (*UpdatedMp4SupportResponse) GetHTTPMeta ¶ added in v1.0.0
func (u *UpdatedMp4SupportResponse) GetHTTPMeta() components.HTTPMetadata
func (*UpdatedMp4SupportResponse) GetObject ¶ added in v1.0.0
func (u *UpdatedMp4SupportResponse) GetObject() *UpdatedMp4SupportResponseBody
type UpdatedMp4SupportResponseBody ¶ added in v1.0.0
type UpdatedMp4SupportResponseBody struct {
// Demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
Data *components.Media `json:"data,omitempty"`
}
UpdatedMp4SupportResponseBody - Media details updated successfully
func (*UpdatedMp4SupportResponseBody) GetData ¶ added in v1.0.0
func (u *UpdatedMp4SupportResponseBody) GetData() *components.Media
func (*UpdatedMp4SupportResponseBody) GetSuccess ¶ added in v1.0.0
func (u *UpdatedMp4SupportResponseBody) GetSuccess() *bool
type UpdatedSourceAccessRequest ¶ added in v1.0.0
type UpdatedSourceAccessRequest struct {
// When creating the media, FastPix assigns a universally unique identifier with a maximum length of 255 characters.
//
MediaID string `pathParam:"style=simple,explode=false,name=mediaId"`
RequestBody UpdatedSourceAccessRequestBody `request:"mediaType=application/json"`
}
func (*UpdatedSourceAccessRequest) GetMediaID ¶ added in v1.0.0
func (u *UpdatedSourceAccessRequest) GetMediaID() string
func (*UpdatedSourceAccessRequest) GetRequestBody ¶ added in v1.0.0
func (u *UpdatedSourceAccessRequest) GetRequestBody() UpdatedSourceAccessRequestBody
type UpdatedSourceAccessRequestBody ¶ added in v1.0.0
type UpdatedSourceAccessRequestBody struct {
// 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"`
}
func (*UpdatedSourceAccessRequestBody) GetSourceAccess ¶ added in v1.0.0
func (u *UpdatedSourceAccessRequestBody) GetSourceAccess() *bool
type UpdatedSourceAccessResponse ¶ added in v1.0.0
type UpdatedSourceAccessResponse struct {
HTTPMeta components.HTTPMetadata `json:"-"`
// Media details updated successfully
Object *UpdatedSourceAccessResponseBody
}
func (*UpdatedSourceAccessResponse) GetHTTPMeta ¶ added in v1.0.0
func (u *UpdatedSourceAccessResponse) GetHTTPMeta() components.HTTPMetadata
func (*UpdatedSourceAccessResponse) GetObject ¶ added in v1.0.0
func (u *UpdatedSourceAccessResponse) GetObject() *UpdatedSourceAccessResponseBody
type UpdatedSourceAccessResponseBody ¶ added in v1.0.0
type UpdatedSourceAccessResponseBody struct {
// Demonstrates whether the request is successful or not.
Success *bool `json:"success,omitempty"`
Data *components.Media `json:"data,omitempty"`
}
UpdatedSourceAccessResponseBody - Media details updated successfully
func (*UpdatedSourceAccessResponseBody) GetData ¶ added in v1.0.0
func (u *UpdatedSourceAccessResponseBody) GetData() *components.Media
func (*UpdatedSourceAccessResponseBody) GetSuccess ¶ added in v1.0.0
func (u *UpdatedSourceAccessResponseBody) GetSuccess() *bool
Source Files
¶
- addmediatoplaylist.go
- addmediatrack.go
- cancelupload.go
- changemediaorderinplaylist.go
- completelivestream.go
- createaplaylist.go
- createmedia.go
- createmediaplaybackid.go
- createnewstream.go
- createplaybackidofstream.go
- createsigningkey.go
- createsimulcastofstream.go
- deleteaplaylist.go
- deletelivestream.go
- deletemedia.go
- deletemediafromplaylist.go
- deletemediaplaybackid.go
- deletemediatrack.go
- deleteplaybackidofstream.go
- deletesigningkey.go
- deletesimulcastofstream.go
- directuploadvideomedia.go
- disablelivestream.go
- enablelivestream.go
- generatesubtitletrack.go
- getallplaylists.go
- getallstreams.go
- getdataviewlistcurrentviewsfilter.go
- getdataviewlistcurrentviewsgettimeseriesviews.go
- getdrmconfiguration.go
- getdrmconfigurationbyid.go
- getlivestreambyid.go
- getlivestreamplaybackid.go
- getlivestreamviewercountbyid.go
- getmedia.go
- getmediaclips.go
- getplaybackid.go
- getplaylistbyid.go
- getsigningkeybyid.go
- getspecificsimulcastofstream.go
- gettimeseriesdata.go
- getvideoviewdetails.go
- listbreakdownvalues.go
- listbytopcontent.go
- listcomparisonvalues.go
- listdimensions.go
- listerrors.go
- listfiltervaluesfordimension.go
- listliveclips.go
- listmedia.go
- listoverallvalues.go
- listsigningkeys.go
- listuploads.go
- listvideoviews.go
- options.go
- retrievemediainputinfo.go
- updateaplaylist.go
- updatedmedia.go
- updatedmp4support.go
- updatedsourceaccess.go
- updatelivestream.go
- updatemediachapters.go
- updatemediamoderation.go
- updatemedianamedentities.go
- updatemediasummary.go
- updatemediatrack.go
- updatespecificsimulcastofstream.go