kinesisvideoarchivedmedia

package
v1.14.28 Latest Latest
Warning

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

 Go to latest Published: Jul 17, 2018 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package kinesisvideoarchivedmedia provides the client and types for making API requests to Amazon Kinesis Video Streams Archived Media.

See https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30 for more information on this service.

See kinesisvideoarchivedmedia package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/kinesisvideoarchivedmedia/

Using the Client

To contact Amazon Kinesis Video Streams Archived Media with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Kinesis Video Streams Archived Media client KinesisVideoArchivedMedia for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/kinesisvideoarchivedmedia/#New

Index

Constants

View Source 
const (
	// DiscontinuityModeAlways is a DiscontinuityMode enum value
	DiscontinuityModeAlways = "ALWAYS"

	// DiscontinuityModeNever is a DiscontinuityMode enum value
	DiscontinuityModeNever = "NEVER"
)
View Source 
const (
	// FragmentSelectorTypeProducerTimestamp is a FragmentSelectorType enum value
	FragmentSelectorTypeProducerTimestamp = "PRODUCER_TIMESTAMP"

	// FragmentSelectorTypeServerTimestamp is a FragmentSelectorType enum value
	FragmentSelectorTypeServerTimestamp = "SERVER_TIMESTAMP"
)
View Source 
const (
	// HLSFragmentSelectorTypeProducerTimestamp is a HLSFragmentSelectorType enum value
	HLSFragmentSelectorTypeProducerTimestamp = "PRODUCER_TIMESTAMP"

	// HLSFragmentSelectorTypeServerTimestamp is a HLSFragmentSelectorType enum value
	HLSFragmentSelectorTypeServerTimestamp = "SERVER_TIMESTAMP"
)
View Source 
const (
	// PlaybackModeLive is a PlaybackMode enum value
	PlaybackModeLive = "LIVE"

	// PlaybackModeOnDemand is a PlaybackMode enum value
	PlaybackModeOnDemand = "ON_DEMAND"
)
View Source 
const (

	// ErrCodeClientLimitExceededException for service response error code
	// "ClientLimitExceededException".
	//
	// Kinesis Video Streams has throttled the request because you have exceeded
	// the limit of allowed client calls. Try making the call later.
	ErrCodeClientLimitExceededException = "ClientLimitExceededException"

	// ErrCodeInvalidArgumentException for service response error code
	// "InvalidArgumentException".
	//
	// A specified parameter exceeds its restrictions, is not supported, or can't
	// be used.
	ErrCodeInvalidArgumentException = "InvalidArgumentException"

	// ErrCodeInvalidCodecPrivateDataException for service response error code
	// "InvalidCodecPrivateDataException".
	//
	// The Codec Private Data in the video stream is not valid for this operation.
	ErrCodeInvalidCodecPrivateDataException = "InvalidCodecPrivateDataException"

	// ErrCodeMissingCodecPrivateDataException for service response error code
	// "MissingCodecPrivateDataException".
	//
	// No Codec Private Data was found in the video stream.
	ErrCodeMissingCodecPrivateDataException = "MissingCodecPrivateDataException"

	// ErrCodeNoDataRetentionException for service response error code
	// "NoDataRetentionException".
	//
	// A PlaybackMode of ON_DEMAND was requested for a stream that does not retain
	// data (that is, has a DataRetentionInHours of 0).
	ErrCodeNoDataRetentionException = "NoDataRetentionException"

	// ErrCodeNotAuthorizedException for service response error code
	// "NotAuthorizedException".
	//
	// Status Code: 403, The caller is not authorized to perform an operation on
	// the given stream, or the token has expired.
	ErrCodeNotAuthorizedException = "NotAuthorizedException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// GetMedia throws this error when Kinesis Video Streams can't find the stream
	// that you specified.
	//
	// GetHLSStreamingSessionURL throws this error if a session with a PlaybackMode
	// of ON_DEMAND is requested for a stream that has no fragments within the requested
	// time range, or if a session with a PlaybackMode of LIVE is requested for
	// a stream that has no fragments within the last 30 seconds.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeUnsupportedStreamMediaTypeException for service response error code
	// "UnsupportedStreamMediaTypeException".
	//
	// An HLS streaming session was requested for a stream with a media type that
	// is not video/h264.
	ErrCodeUnsupportedStreamMediaTypeException = "UnsupportedStreamMediaTypeException"
)
View Source 
const (
	ServiceName = "kinesisvideo"                 // Name of service.
	EndpointsID = ServiceName                    // ID to lookup a service endpoint with.
	ServiceID   = "Kinesis Video Archived Media" // ServiceID is a unique identifer of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type Fragment 

type Fragment struct {

	// The playback duration or other time value associated with the fragment.
	FragmentLengthInMilliseconds *int64 `type:"long"`

	// The index value of the fragment.
	FragmentNumber *string `min:"1" type:"string"`

	// The total fragment size, including information about the fragment and contained
	// media data.
	FragmentSizeInBytes *int64 `type:"long"`

	// The time stamp from the producer corresponding to the fragment.
	ProducerTimestamp *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The time stamp from the AWS server corresponding to the fragment.
	ServerTimestamp *time.Time `type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

Represents a segment of video or other time-delimited data.

func (Fragment) GoString 

func (s Fragment) GoString() string

GoString returns the string representation

func (*Fragment) SetFragmentLengthInMilliseconds 

func (s *Fragment) SetFragmentLengthInMilliseconds(v int64) *Fragment

SetFragmentLengthInMilliseconds sets the FragmentLengthInMilliseconds field's value.

func (*Fragment) SetFragmentNumber 

func (s *Fragment) SetFragmentNumber(v string) *Fragment

SetFragmentNumber sets the FragmentNumber field's value.

func (*Fragment) SetFragmentSizeInBytes 

func (s *Fragment) SetFragmentSizeInBytes(v int64) *Fragment

SetFragmentSizeInBytes sets the FragmentSizeInBytes field's value.

func (*Fragment) SetProducerTimestamp 

func (s *Fragment) SetProducerTimestamp(v time.Time) *Fragment

SetProducerTimestamp sets the ProducerTimestamp field's value.

func (*Fragment) SetServerTimestamp 

func (s *Fragment) SetServerTimestamp(v time.Time) *Fragment

SetServerTimestamp sets the ServerTimestamp field's value.

func (Fragment) String 

func (s Fragment) String() string

String returns the string representation

type FragmentSelector 

type FragmentSelector struct {

	// The origin of the time stamps to use (Server or Producer).
	//
	// FragmentSelectorType is a required field
	FragmentSelectorType *string `type:"string" required:"true" enum:"FragmentSelectorType"`

	// The range of time stamps to return.
	//
	// TimestampRange is a required field
	TimestampRange *TimestampRange `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Describes the time stamp range and time stamp origin of a range of fragments.

func (FragmentSelector) GoString 

func (s FragmentSelector) GoString() string

GoString returns the string representation

func (*FragmentSelector) SetFragmentSelectorType 

func (s *FragmentSelector) SetFragmentSelectorType(v string) *FragmentSelector

SetFragmentSelectorType sets the FragmentSelectorType field's value.

func (*FragmentSelector) SetTimestampRange 

func (s *FragmentSelector) SetTimestampRange(v *TimestampRange) *FragmentSelector

SetTimestampRange sets the TimestampRange field's value.

func (FragmentSelector) String 

func (s FragmentSelector) String() string

String returns the string representation

func (*FragmentSelector) Validate 

func (s *FragmentSelector) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetHLSStreamingSessionURLInput added in v1.14.27 

type GetHLSStreamingSessionURLInput struct {

	// Specifies when flags marking discontinuities between fragments will be added
	// to the media playlists. The default is ALWAYS when HLSFragmentSelector is
	// SERVER_TIMESTAMP, and NEVER when it is PRODUCER_TIMESTAMP.
	//
	// Media players typically build a timeline of media content to play, based
	// on the time stamps of each fragment. This means that if there is any overlap
	// between fragments (as is typical if HLSFragmentSelector is SERVER_TIMESTAMP),
	// the media player timeline has small gaps between fragments in some places,
	// and overwrites frames in other places. When there are discontinuity flags
	// between fragments, the media player is expected to reset the timeline, resulting
	// in the fragment being played immediately after the previous fragment. We
	// recommend that you always have discontinuity flags between fragments if the
	// fragment time stamps are not accurate or if fragments might be missing. You
	// should not place discontinuity flags between fragments for the player timeline
	// to accurately map to the producer time stamps.
	DiscontinuityMode *string `type:"string" enum:"DiscontinuityMode"`

	// The time in seconds until the requested session expires. This value can be
	// between 300 (5 minutes) and 43200 (12 hours).
	//
	// When a session expires, no new calls to GetHLSMasterPlaylist, GetHLSMediaPlaylist,
	// GetMP4InitFragment, or GetMP4MediaFragment can be made for that session.
	//
	// The default is 300 (5 minutes).
	Expires *int64 `min:"300" type:"integer"`

	// The time range of the requested fragment, and the source of the time stamps.
	//
	// This parameter is required if PlaybackMode is ON_DEMAND. This parameter is
	// optional if PlaybackMode is LIVE. If PlaybackMode is LIVE, the FragmentSelectorType
	// can be set, but the TimestampRange should not be set. If PlaybackMode is
	// ON_DEMAND, both FragmentSelectorType and TimestampRange must be set.
	HLSFragmentSelector *HLSFragmentSelector `type:"structure"`

	// The maximum number of fragments that are returned in the HLS media playlists.
	//
	// When the PlaybackMode is LIVE, the most recent fragments are returned up
	// to this value. When the PlaybackMode is ON_DEMAND, the oldest fragments are
	// returned, up to this maximum number.
	//
	// When there are a higher number of fragments available in a live HLS media
	// playlist, video players often buffer content before starting playback. Increasing
	// the buffer size increases the playback latency, but it decreases the likelihood
	// that rebuffering will occur during playback. We recommend that a live HLS
	// media playlist have a minimum of 3 fragments and a maximum of 10 fragments.
	//
	// The default is 5 fragments if PlaybackMode is LIVE, and 1,000 if PlaybackMode
	// is ON_DEMAND.
	//
	// The maximum value of 1,000 fragments corresponds to more than 16 minutes
	// of video on streams with 1-second fragments, and more than 2 1/2 hours of
	// video on streams with 10-second fragments.
	MaxMediaPlaylistFragmentResults *int64 `min:"1" type:"long"`

	// Whether to retrieve live or archived, on-demand data.
	//
	// Features of the two types of session include the following:
	//
	//    * LIVE: For sessions of this type, the HLS media playlist is continually
	//    updated with the latest fragments as they become available. We recommend
	//    that the media player retrieve a new playlist on a one-second interval.
	//    When this type of session is played in a media player, the user interface
	//    typically displays a "live" notification, with no scrubber control for
	//    choosing the position in the playback window to display.
	//
	// In LIVE mode, the newest available fragments are included in an HLS media
	//    playlist, even if there is a gap between fragments (that is, if a fragment
	//    is missing). A gap like this might cause a media player to halt or cause
	//    a jump in playback. In this mode, fragments are not added to the HLS media
	//    playlist if they are older than the newest fragment in the playlist. If
	//    the missing fragment becomes available after a subsequent fragment is
	//    added to the playlist, the older fragment is not added, and the gap is
	//    not filled.
	//
	//    * ON_DEMAND: For sessions of this type, the HLS media playlist contains
	//    all the fragments for the session, up to the number that is specified
	//    in MaxMediaPlaylistFragmentResults. The playlist must be retrieved only
	//    once for each session. When this type of session is played in a media
	//    player, the user interface typically displays a scrubber control for choosing
	//    the position in the playback window to display.
	//
	// In both playback modes, if FragmentSelectorType is PRODUCER_TIMESTAMP, and
	// if there are multiple fragments with the same start time stamp, the fragment
	// that has the larger fragment number (that is, the newer fragment) is included
	// in the HLS media playlist. The other fragments are not included. Fragments
	// that have different time stamps but have overlapping durations are still
	// included in the HLS media playlist. This can lead to unexpected behavior
	// in the media player.
	//
	// The default is LIVE.
	PlaybackMode *string `type:"string" enum:"PlaybackMode"`

	// The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS
	// master playlist URL.
	//
	// You must specify either the StreamName or the StreamARN.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream for which to retrieve the HLS master playlist URL.
	//
	// You must specify either the StreamName or the StreamARN.
	StreamName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetHLSStreamingSessionURLInput) GoString added in v1.14.27 

func (s GetHLSStreamingSessionURLInput) GoString() string

GoString returns the string representation

func (*GetHLSStreamingSessionURLInput) SetDiscontinuityMode added in v1.14.27 

func (s *GetHLSStreamingSessionURLInput) SetDiscontinuityMode(v string) *GetHLSStreamingSessionURLInput

SetDiscontinuityMode sets the DiscontinuityMode field's value.

func (*GetHLSStreamingSessionURLInput) SetExpires added in v1.14.27 

func (s *GetHLSStreamingSessionURLInput) SetExpires(v int64) *GetHLSStreamingSessionURLInput

SetExpires sets the Expires field's value.

func (*GetHLSStreamingSessionURLInput) SetHLSFragmentSelector added in v1.14.27 

func (s *GetHLSStreamingSessionURLInput) SetHLSFragmentSelector(v *HLSFragmentSelector) *GetHLSStreamingSessionURLInput

SetHLSFragmentSelector sets the HLSFragmentSelector field's value.

func (*GetHLSStreamingSessionURLInput) SetMaxMediaPlaylistFragmentResults added in v1.14.27 

func (s *GetHLSStreamingSessionURLInput) SetMaxMediaPlaylistFragmentResults(v int64) *GetHLSStreamingSessionURLInput

SetMaxMediaPlaylistFragmentResults sets the MaxMediaPlaylistFragmentResults field's value.

func (*GetHLSStreamingSessionURLInput) SetPlaybackMode added in v1.14.27 

func (s *GetHLSStreamingSessionURLInput) SetPlaybackMode(v string) *GetHLSStreamingSessionURLInput

SetPlaybackMode sets the PlaybackMode field's value.

func (*GetHLSStreamingSessionURLInput) SetStreamARN added in v1.14.27 

func (s *GetHLSStreamingSessionURLInput) SetStreamARN(v string) *GetHLSStreamingSessionURLInput

SetStreamARN sets the StreamARN field's value.

func (*GetHLSStreamingSessionURLInput) SetStreamName added in v1.14.27 

func (s *GetHLSStreamingSessionURLInput) SetStreamName(v string) *GetHLSStreamingSessionURLInput

SetStreamName sets the StreamName field's value.

func (GetHLSStreamingSessionURLInput) String added in v1.14.27 

func (s GetHLSStreamingSessionURLInput) String() string

String returns the string representation

func (*GetHLSStreamingSessionURLInput) Validate added in v1.14.27 

func (s *GetHLSStreamingSessionURLInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetHLSStreamingSessionURLOutput added in v1.14.27 

type GetHLSStreamingSessionURLOutput struct {

	// The URL (containing the session token) that a media player can use to retrieve
	// the HLS master playlist.
	HLSStreamingSessionURL *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetHLSStreamingSessionURLOutput) GoString added in v1.14.27 

func (s GetHLSStreamingSessionURLOutput) GoString() string

GoString returns the string representation

func (*GetHLSStreamingSessionURLOutput) SetHLSStreamingSessionURL added in v1.14.27 

func (s *GetHLSStreamingSessionURLOutput) SetHLSStreamingSessionURL(v string) *GetHLSStreamingSessionURLOutput

SetHLSStreamingSessionURL sets the HLSStreamingSessionURL field's value.

func (GetHLSStreamingSessionURLOutput) String added in v1.14.27 

func (s GetHLSStreamingSessionURLOutput) String() string

String returns the string representation

type GetMediaForFragmentListInput 

type GetMediaForFragmentListInput struct {

	// A list of the numbers of fragments for which to retrieve media. You retrieve
	// these values with ListFragments.
	//
	// Fragments is a required field
	Fragments []*string `min:"1" type:"list" required:"true"`

	// The name of the stream from which to retrieve fragment media.
	//
	// StreamName is a required field
	StreamName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetMediaForFragmentListInput) GoString 

func (s GetMediaForFragmentListInput) GoString() string

GoString returns the string representation

func (*GetMediaForFragmentListInput) SetFragments 

func (s *GetMediaForFragmentListInput) SetFragments(v []*string) *GetMediaForFragmentListInput

SetFragments sets the Fragments field's value.

func (*GetMediaForFragmentListInput) SetStreamName 

func (s *GetMediaForFragmentListInput) SetStreamName(v string) *GetMediaForFragmentListInput

SetStreamName sets the StreamName field's value.

func (GetMediaForFragmentListInput) String 

func (s GetMediaForFragmentListInput) String() string

String returns the string representation

func (*GetMediaForFragmentListInput) Validate 

func (s *GetMediaForFragmentListInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetMediaForFragmentListOutput 

type GetMediaForFragmentListOutput struct {

	// The content type of the requested media.
	ContentType *string `location:"header" locationName:"Content-Type" min:"1" type:"string"`

	// The payload that Kinesis Video Streams returns is a sequence of chunks from
	// the specified stream. For information about the chunks, see PutMedia (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_dataplane_PutMedia.html).
	// The chunks that Kinesis Video Streams returns in the GetMediaForFragmentList
	// call also include the following additional Matroska (MKV) tags:
	//
	//    * AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk.
	//
	//    * AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side time stamp of the
	//    fragment.
	//
	//    * AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side time stamp
	//    of the fragment.
	//
	// The following tags will be included if an exception occurs:
	//
	//    * AWS_KINESISVIDEO_FRAGMENT_NUMBER - The number of the fragment that threw
	//    the exception
	//
	//    * AWS_KINESISVIDEO_EXCEPTION_ERROR_CODE - The integer code of the exception
	//
	//    * AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception
	Payload io.ReadCloser `type:"blob"`
	// contains filtered or unexported fields
}

func (GetMediaForFragmentListOutput) GoString 

func (s GetMediaForFragmentListOutput) GoString() string

GoString returns the string representation

func (*GetMediaForFragmentListOutput) SetContentType 

func (s *GetMediaForFragmentListOutput) SetContentType(v string) *GetMediaForFragmentListOutput

SetContentType sets the ContentType field's value.

func (*GetMediaForFragmentListOutput) SetPayload 

func (s *GetMediaForFragmentListOutput) SetPayload(v io.ReadCloser) *GetMediaForFragmentListOutput

SetPayload sets the Payload field's value.

func (GetMediaForFragmentListOutput) String 

func (s GetMediaForFragmentListOutput) String() string

String returns the string representation

type HLSFragmentSelector added in v1.14.27 

type HLSFragmentSelector struct {

	// The source of the time stamps for the requested media.
	//
	// When FragmentSelectorType is set to PRODUCER_TIMESTAMP and GetHLSStreamingSessionURLInput$PlaybackMode
	// is ON_DEMAND, the first fragment ingested with a producer time stamp within
	// the specified FragmentSelector$TimestampRange is included in the media playlist.
	// In addition, the fragments with producer time stamps within the TimestampRange
	// ingested immediately following the first fragment (up to the GetHLSStreamingSessionURLInput$MaxMediaPlaylistFragmentResults
	// value) are included.
	//
	// Fragments that have duplicate producer time stamps are deduplicated. This
	// means that if producers are producing a stream of fragments with producer
	// time stamps that are approximately equal to the true clock time, the HLS
	// media playlists will contain all of the fragments within the requested time
	// stamp range. If some fragments are ingested within the same time range and
	// very different points in time, only the oldest ingested collection of fragments
	// are returned.
	//
	// When FragmentSelectorType is set to PRODUCER_TIMESTAMP and GetHLSStreamingSessionURLInput$PlaybackMode
	// is LIVE, the producer time stamps are used in the MP4 fragments and for deduplication.
	// But the most recently ingested fragments based on server time stamps are
	// included in the HLS media playlist. This means that even if fragments ingested
	// in the past have producer time stamps with values now, they are not included
	// in the HLS media playlist.
	//
	// The default is SERVER_TIMESTAMP.
	FragmentSelectorType *string `type:"string" enum:"HLSFragmentSelectorType"`

	// The start and end of the time stamp range for the requested media.
	//
	// This value should not be present if PlaybackType is LIVE.
	TimestampRange *HLSTimestampRange `type:"structure"`
	// contains filtered or unexported fields
}

Contains the range of time stamps for the requested media, and the source of the time stamps.

func (HLSFragmentSelector) GoString added in v1.14.27 

func (s HLSFragmentSelector) GoString() string

GoString returns the string representation

func (*HLSFragmentSelector) SetFragmentSelectorType added in v1.14.27 

func (s *HLSFragmentSelector) SetFragmentSelectorType(v string) *HLSFragmentSelector

SetFragmentSelectorType sets the FragmentSelectorType field's value.

func (*HLSFragmentSelector) SetTimestampRange added in v1.14.27 

func (s *HLSFragmentSelector) SetTimestampRange(v *HLSTimestampRange) *HLSFragmentSelector

SetTimestampRange sets the TimestampRange field's value.

func (HLSFragmentSelector) String added in v1.14.27 

func (s HLSFragmentSelector) String() string

String returns the string representation

type HLSTimestampRange added in v1.14.27 

type HLSTimestampRange struct {

	// The end of the time stamp range for the requested media. This value must
	// be within 3 hours of the specified StartTimestamp, and it must be later than
	// the StartTimestamp value.
	//
	// If FragmentSelectorType for the request is SERVER_TIMESTAMP, this value must
	// be in the past.
	//
	// If the HLSTimestampRange value is specified, the EndTimestamp value is required.
	//
	// This value is inclusive. The EndTimestamp is compared to the (starting) time
	// stamp of the fragment. Fragments that start before the EndTimestamp value
	// and continue past it are included in the session.
	EndTimestamp *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The start of the time stamp range for the requested media.
	//
	// If the HLSTimestampRange value is specified, the StartTimestamp value is
	// required.
	//
	// This value is inclusive. Fragments that start before the StartTimestamp and
	// continue past it are included in the session. If FragmentSelectorType is
	// SERVER_TIMESTAMP, the StartTimestamp must be later than the stream head.
	StartTimestamp *time.Time `type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

The start and end of the time stamp range for the requested media.

This value should not be present if PlaybackType is LIVE.

The values in the HLSTimestampRange are inclusive. Fragments that begin before the start time but continue past it, or fragments that begin before the end time but continue past it, are included in the session.

func (HLSTimestampRange) GoString added in v1.14.27 

func (s HLSTimestampRange) GoString() string

GoString returns the string representation

func (*HLSTimestampRange) SetEndTimestamp added in v1.14.27 

func (s *HLSTimestampRange) SetEndTimestamp(v time.Time) *HLSTimestampRange

SetEndTimestamp sets the EndTimestamp field's value.

func (*HLSTimestampRange) SetStartTimestamp added in v1.14.27 

func (s *HLSTimestampRange) SetStartTimestamp(v time.Time) *HLSTimestampRange

SetStartTimestamp sets the StartTimestamp field's value.

func (HLSTimestampRange) String added in v1.14.27 

func (s HLSTimestampRange) String() string

String returns the string representation

type KinesisVideoArchivedMedia 

type KinesisVideoArchivedMedia struct {
	*client.Client
}

KinesisVideoArchivedMedia provides the API operation methods for making requests to Amazon Kinesis Video Streams Archived Media. See this package's package overview docs for details on the service.

KinesisVideoArchivedMedia methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *KinesisVideoArchivedMedia

New creates a new instance of the KinesisVideoArchivedMedia client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a KinesisVideoArchivedMedia client from just a session.
svc := kinesisvideoarchivedmedia.New(mySession)

// Create a KinesisVideoArchivedMedia client with additional configuration
svc := kinesisvideoarchivedmedia.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*KinesisVideoArchivedMedia) GetHLSStreamingSessionURL added in v1.14.27 

func (c *KinesisVideoArchivedMedia) GetHLSStreamingSessionURL(input *GetHLSStreamingSessionURLInput) (*GetHLSStreamingSessionURLOutput, error)

GetHLSStreamingSessionURL API operation for Amazon Kinesis Video Streams Archived Media.

Retrieves an HTTP Live Streaming (HLS) URL for the stream. You can then open the URL in a browser or media player to view the stream contents.

You must specify either the StreamName or the StreamARN.

An Amazon Kinesis video stream has the following requirements for providing data through HLS:

Kinesis Video Streams HLS sessions contain fragments in the fragmented MPEG-4 form (also called fMP4 or CMAF), rather than the MPEG-2 form (also called TS chunks, which the HLS specification also supports). For more information about HLS fragment types, see the HLS specification (https://tools.ietf.org/html/draft-pantos-http-live-streaming-23).

The following procedure shows how to use HLS with Kinesis Video Streams:

Get an endpoint using GetDataEndpoint (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_GetDataEndpoint.html), specifying GET_HLS_STREAMING_SESSION_URL for the APIName parameter.

Retrieve the HLS URL using GetHLSStreamingSessionURL. Kinesis Video Streams creates an HLS streaming session to be used for accessing content in a stream using the HLS protocol. GetHLSStreamingSessionURL returns an authenticated URL (that includes an encrypted session token) for the session's HLS master playlist (the root resource needed for streaming with HLS).

Don't share or store this token where an unauthorized entity could access it. The token provides access to the content of the stream. Safeguard the token with the same measures that you would use with your AWS credentials.

The media that is made available through the playlist consists only of the requested stream, time range, and format. No other media data (such as frames outside the requested window or alternate bit rates) is made available.

Provide the URL (containing the encrypted session token) for the HLS master playlist to a media player that supports the HLS protocol. Kinesis Video Streams makes the HLS media playlist, initialization fragment, and media fragments available through the master playlist URL. The initialization fragment contains the codec private data for the stream, and other data needed to set up the video decoder and renderer. The media fragments contain H.264-encoded video frames and time stamps.

The media player receives the authenticated URL and requests stream metadata and media data normally. When the media player requests data, it calls the following actions:

GetHLSMasterPlaylist: Retrieves an HLS master playlist, which contains a URL for the GetHLSMediaPlaylist action, and additional metadata for the media player, including estimated bit rate and resolution.

GetHLSMediaPlaylist: Retrieves an HLS media playlist, which contains a URL to access the MP4 initialization fragment with the GetMP4InitFragment action, and URLs to access the MP4 media fragments with the GetMP4MediaFragment actions. The HLS media playlist also contains metadata about the stream that the player needs to play it, such as whether the PlaybackMode is LIVE or ON_DEMAND. The HLS media playlist is typically static for sessions with a PlaybackType of ON_DEMAND. The HLS media playlist is continually updated with new fragments for sessions with a PlaybackType of LIVE.

GetMP4InitFragment: Retrieves the MP4 initialization fragment. The media player typically loads the initialization fragment before loading any media fragments. This fragment contains the "fytp" and "moov" MP4 atoms, and the child atoms that are needed to initialize the media player decoder.

The initialization fragment does not correspond to a fragment in a Kinesis video stream. It contains only the codec private data for the stream, which the media player needs to decode video frames.

GetMP4MediaFragment: Retrieves MP4 media fragments. These fragments contain the "moof" and "mdat" MP4 atoms and their child atoms, containing the encoded fragment's video frames and their time stamps.

After the first media fragment is made available in a streaming session, any fragments that don't contain the same codec private data are excluded in the HLS media playlist. Therefore, the codec private data does not change between fragments in a session.

Data retrieved with this action is billable. See Pricing (aws.amazon.comkinesis/video-streams/pricing/) for details.

The following restrictions apply to HLS sessions:

A streaming session URL should not be shared between players. The service might throttle a session if multiple media players are sharing it. For connection limits, see Kinesis Video Streams Limits (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html).

A Kinesis video stream can have a maximum of five active HLS streaming sessions. If a new session is created when the maximum number of sessions is already active, the oldest (earliest created) session is closed. The number of active GetMedia connections on a Kinesis video stream does not count against this limit, and the number of active HLS sessions does not count against the active GetMedia connection limit.

You can monitor the amount of data that the media player consumes by monitoring the GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html). For pricing information, see Amazon Kinesis Video Streams Pricing (https://aws.amazon.com/kinesis/video-streams/pricing/) and AWS Pricing (https://aws.amazon.com/pricing/). Charges for both HLS sessions and outgoing AWS data apply.

For more information about HLS, see HTTP Live Streaming (https://developer.apple.com/streaming/) on the Apple Developer site (https://developer.apple.com).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams Archived Media's API operation GetHLSStreamingSessionURL for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" GetMedia throws this error when Kinesis Video Streams can't find the stream that you specified.

    GetHLSStreamingSessionURL throws this error if a session with a PlaybackMode of ON_DEMAND is requested for a stream that has no fragments within the requested time range, or if a session with a PlaybackMode of LIVE is requested for a stream that has no fragments within the last 30 seconds.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" A specified parameter exceeds its restrictions, is not supported, or can't be used.

  • ErrCodeClientLimitExceededException "ClientLimitExceededException" Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

  • ErrCodeUnsupportedStreamMediaTypeException "UnsupportedStreamMediaTypeException" An HLS streaming session was requested for a stream with a media type that is not video/h264.

  • ErrCodeNoDataRetentionException "NoDataRetentionException" A PlaybackMode of ON_DEMAND was requested for a stream that does not retain data (that is, has a DataRetentionInHours of 0).

  • ErrCodeMissingCodecPrivateDataException "MissingCodecPrivateDataException" No Codec Private Data was found in the video stream.

  • ErrCodeInvalidCodecPrivateDataException "InvalidCodecPrivateDataException" The Codec Private Data in the video stream is not valid for this operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetHLSStreamingSessionURL

func (*KinesisVideoArchivedMedia) GetHLSStreamingSessionURLRequest added in v1.14.27 

func (c *KinesisVideoArchivedMedia) GetHLSStreamingSessionURLRequest(input *GetHLSStreamingSessionURLInput) (req *request.Request, output *GetHLSStreamingSessionURLOutput)

GetHLSStreamingSessionURLRequest generates a "aws/request.Request" representing the client's request for the GetHLSStreamingSessionURL operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetHLSStreamingSessionURL for more information on using the GetHLSStreamingSessionURL API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetHLSStreamingSessionURLRequest method.
req, resp := client.GetHLSStreamingSessionURLRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetHLSStreamingSessionURL

func (*KinesisVideoArchivedMedia) GetHLSStreamingSessionURLWithContext added in v1.14.27 

func (c *KinesisVideoArchivedMedia) GetHLSStreamingSessionURLWithContext(ctx aws.Context, input *GetHLSStreamingSessionURLInput, opts ...request.Option) (*GetHLSStreamingSessionURLOutput, error)

GetHLSStreamingSessionURLWithContext is the same as GetHLSStreamingSessionURL with the addition of the ability to pass a context and additional request options.

See GetHLSStreamingSessionURL for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideoArchivedMedia) GetMediaForFragmentList 

func (c *KinesisVideoArchivedMedia) GetMediaForFragmentList(input *GetMediaForFragmentListInput) (*GetMediaForFragmentListOutput, error)

GetMediaForFragmentList API operation for Amazon Kinesis Video Streams Archived Media.

Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.

The following limits apply when using the GetMediaForFragmentList API:

  • A client can call GetMediaForFragmentList up to five times per second per stream.

  • Kinesis Video Streams sends media data at a rate of up to 25 megabytes per second (or 200 megabits per second) during a GetMediaForFragmentList session.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams Archived Media's API operation GetMediaForFragmentList for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" GetMedia throws this error when Kinesis Video Streams can't find the stream that you specified.

    GetHLSStreamingSessionURL throws this error if a session with a PlaybackMode of ON_DEMAND is requested for a stream that has no fragments within the requested time range, or if a session with a PlaybackMode of LIVE is requested for a stream that has no fragments within the last 30 seconds.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" A specified parameter exceeds its restrictions, is not supported, or can't be used.

  • ErrCodeClientLimitExceededException "ClientLimitExceededException" Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetMediaForFragmentList

func (*KinesisVideoArchivedMedia) GetMediaForFragmentListRequest 

func (c *KinesisVideoArchivedMedia) GetMediaForFragmentListRequest(input *GetMediaForFragmentListInput) (req *request.Request, output *GetMediaForFragmentListOutput)

GetMediaForFragmentListRequest generates a "aws/request.Request" representing the client's request for the GetMediaForFragmentList operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetMediaForFragmentList for more information on using the GetMediaForFragmentList API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetMediaForFragmentListRequest method.
req, resp := client.GetMediaForFragmentListRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetMediaForFragmentList

func (*KinesisVideoArchivedMedia) GetMediaForFragmentListWithContext 

func (c *KinesisVideoArchivedMedia) GetMediaForFragmentListWithContext(ctx aws.Context, input *GetMediaForFragmentListInput, opts ...request.Option) (*GetMediaForFragmentListOutput, error)

GetMediaForFragmentListWithContext is the same as GetMediaForFragmentList with the addition of the ability to pass a context and additional request options.

See GetMediaForFragmentList for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideoArchivedMedia) ListFragments 

func (c *KinesisVideoArchivedMedia) ListFragments(input *ListFragmentsInput) (*ListFragmentsOutput, error)

ListFragments API operation for Amazon Kinesis Video Streams Archived Media.

Returns a list of Fragment objects from the specified stream and start location within the archived data.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams Archived Media's API operation ListFragments for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" GetMedia throws this error when Kinesis Video Streams can't find the stream that you specified.

    GetHLSStreamingSessionURL throws this error if a session with a PlaybackMode of ON_DEMAND is requested for a stream that has no fragments within the requested time range, or if a session with a PlaybackMode of LIVE is requested for a stream that has no fragments within the last 30 seconds.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" A specified parameter exceeds its restrictions, is not supported, or can't be used.

  • ErrCodeClientLimitExceededException "ClientLimitExceededException" Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/ListFragments

func (*KinesisVideoArchivedMedia) ListFragmentsRequest 

func (c *KinesisVideoArchivedMedia) ListFragmentsRequest(input *ListFragmentsInput) (req *request.Request, output *ListFragmentsOutput)

ListFragmentsRequest generates a "aws/request.Request" representing the client's request for the ListFragments operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListFragments for more information on using the ListFragments API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListFragmentsRequest method.
req, resp := client.ListFragmentsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/ListFragments

func (*KinesisVideoArchivedMedia) ListFragmentsWithContext 

func (c *KinesisVideoArchivedMedia) ListFragmentsWithContext(ctx aws.Context, input *ListFragmentsInput, opts ...request.Option) (*ListFragmentsOutput, error)

ListFragmentsWithContext is the same as ListFragments with the addition of the ability to pass a context and additional request options.

See ListFragments for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ListFragmentsInput 

type ListFragmentsInput struct {

	// Describes the time stamp range and time stamp origin for the range of fragments
	// to return.
	FragmentSelector *FragmentSelector `type:"structure"`

	// The total number of fragments to return. If the total number of fragments
	// available is more than the value specified in max-results, then a ListFragmentsOutput$NextToken
	// is provided in the output that you can use to resume pagination.
	MaxResults *int64 `min:"1" type:"long"`

	// A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken
	// from a previously truncated response.
	NextToken *string `min:"1" type:"string"`

	// The name of the stream from which to retrieve a fragment list.
	//
	// StreamName is a required field
	StreamName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListFragmentsInput) GoString 

func (s ListFragmentsInput) GoString() string

GoString returns the string representation

func (*ListFragmentsInput) SetFragmentSelector 

func (s *ListFragmentsInput) SetFragmentSelector(v *FragmentSelector) *ListFragmentsInput

SetFragmentSelector sets the FragmentSelector field's value.

func (*ListFragmentsInput) SetMaxResults 

func (s *ListFragmentsInput) SetMaxResults(v int64) *ListFragmentsInput

SetMaxResults sets the MaxResults field's value.

func (*ListFragmentsInput) SetNextToken 

func (s *ListFragmentsInput) SetNextToken(v string) *ListFragmentsInput

SetNextToken sets the NextToken field's value.

func (*ListFragmentsInput) SetStreamName 

func (s *ListFragmentsInput) SetStreamName(v string) *ListFragmentsInput

SetStreamName sets the StreamName field's value.

func (ListFragmentsInput) String 

func (s ListFragmentsInput) String() string

String returns the string representation

func (*ListFragmentsInput) Validate 

func (s *ListFragmentsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListFragmentsOutput 

type ListFragmentsOutput struct {

	// A list of fragment numbers that correspond to the time stamp range provided.
	Fragments []*Fragment `type:"list"`

	// If the returned list is truncated, the operation returns this token to use
	// to retrieve the next page of results. This value is null when there are no
	// more results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListFragmentsOutput) GoString 

func (s ListFragmentsOutput) GoString() string

GoString returns the string representation

func (*ListFragmentsOutput) SetFragments 

func (s *ListFragmentsOutput) SetFragments(v []*Fragment) *ListFragmentsOutput

SetFragments sets the Fragments field's value.

func (*ListFragmentsOutput) SetNextToken 

func (s *ListFragmentsOutput) SetNextToken(v string) *ListFragmentsOutput

SetNextToken sets the NextToken field's value.

func (ListFragmentsOutput) String 

func (s ListFragmentsOutput) String() string

String returns the string representation

type TimestampRange 

type TimestampRange struct {

	// The ending time stamp in the range of time stamps for which to return fragments.
	//
	// EndTimestamp is a required field
	EndTimestamp *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"`

	// The starting time stamp in the range of time stamps for which to return fragments.
	//
	// StartTimestamp is a required field
	StartTimestamp *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"`
	// contains filtered or unexported fields
}

The range of time stamps for which to return fragments.

func (TimestampRange) GoString 

func (s TimestampRange) GoString() string

GoString returns the string representation

func (*TimestampRange) SetEndTimestamp 

func (s *TimestampRange) SetEndTimestamp(v time.Time) *TimestampRange

SetEndTimestamp sets the EndTimestamp field's value.

func (*TimestampRange) SetStartTimestamp 

func (s *TimestampRange) SetStartTimestamp(v time.Time) *TimestampRange

SetStartTimestamp sets the StartTimestamp field's value.

func (TimestampRange) String 

func (s TimestampRange) String() string

String returns the string representation

func (*TimestampRange) Validate 

func (s *TimestampRange) Validate() error

Validate inspects the fields of the type to determine if they are valid.

Source Files

View all Source files

Directories

Path Synopsis
Package kinesisvideoarchivedmediaiface provides an interface to enable mocking the Amazon Kinesis Video Streams Archived Media service client for testing your code.
 Package kinesisvideoarchivedmediaiface provides an interface to enable mocking the Amazon Kinesis Video Streams Archived Media service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.