Documentation

Overview

    Package kinesisvideomedia provides the API client, operations, and parameter types for Amazon Kinesis Video Streams Media.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2017-09-30"
    View Source
    const ServiceID = "Kinesis Video Media"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

      func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

        WithAPIOptions returns a functional option for setting the Client's APIOptions option.

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type Client

          type Client struct {
          	// contains filtered or unexported fields
          }

            Client provides the API client to make operations call for Amazon Kinesis Video Streams Media.

            func New

            func New(options Options, optFns ...func(*Options)) *Client

              New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

              func NewFromConfig

              func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

                NewFromConfig returns a new client from the provided config.

                func (*Client) GetMedia

                func (c *Client) GetMedia(ctx context.Context, params *GetMediaInput, optFns ...func(*Options)) (*GetMediaOutput, error)

                  Use this API to retrieve media content from a Kinesis video stream. In the request, you identify the stream name or stream Amazon Resource Name (ARN), and the starting chunk. Kinesis Video Streams then returns a stream of chunks in order by fragment number. You must first call the GetDataEndpoint API to get an endpoint. Then send the GetMedia requests to this endpoint using the --endpoint-url parameter (https://docs.aws.amazon.com/cli/latest/reference/). When you put media data (fragments) on a stream, Kinesis Video Streams stores each incoming fragment and related metadata in what is called a "chunk." For more information, see PutMedia (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_dataplane_PutMedia.html). The GetMedia API returns a stream of these chunks starting from the chunk that you specify in the request. The following limits apply when using the GetMedia API:

                  * A client can call GetMedia 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 GetMedia session.

                  If an error is thrown after invoking a Kinesis Video Streams media API, in addition to the HTTP status code and the response body, it includes the following pieces of information:

                  * x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides.

                  * x-amz-RequestId HTTP header – if you want to report an issue to AWS, the support team can better diagnose the problem if given the Request Id.

                  Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again. For more information, see the Errors section at the bottom of this topic, as well as Common Errors (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html).

                  type EndpointResolver

                  type EndpointResolver interface {
                  	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
                  }

                    EndpointResolver interface for resolving service endpoints.

                    func EndpointResolverFromURL

                    func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                      EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                      type EndpointResolverFunc

                      type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

                        EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

                        func (EndpointResolverFunc) ResolveEndpoint

                        func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                        type EndpointResolverOptions

                        type EndpointResolverOptions = internalendpoints.Options

                          EndpointResolverOptions is the service endpoint resolver options

                          type GetMediaInput

                          type GetMediaInput struct {
                          
                          	// Identifies the starting chunk to get from the specified stream.
                          	//
                          	// This member is required.
                          	StartSelector *types.StartSelector
                          
                          	// The ARN of the stream from where you want to get the media content. If you don't
                          	// specify the streamARN, you must specify the streamName.
                          	StreamARN *string
                          
                          	// The Kinesis video stream name from where you want to get the media content. If
                          	// you don't specify the streamName, you must specify the streamARN.
                          	StreamName *string
                          }

                          type GetMediaOutput

                          type GetMediaOutput struct {
                          
                          	// The content type of the requested media.
                          	ContentType *string
                          
                          	// The payload Kinesis Video Streams returns is a sequence of chunks from the
                          	// specified stream. For information about the chunks, see . The chunks that
                          	// Kinesis Video Streams returns in the GetMedia call also include the following
                          	// additional Matroska (MKV) tags:
                          	//
                          	// * AWS_KINESISVIDEO_CONTINUATION_TOKEN (UTF-8
                          	// string) - In the event your GetMedia call terminates, you can use this
                          	// continuation token in your next request to get the next chunk where the last
                          	// request terminated.
                          	//
                          	// * AWS_KINESISVIDEO_MILLIS_BEHIND_NOW (UTF-8 string) -
                          	// Client applications can use this tag value to determine how far behind the chunk
                          	// returned in the response is from the latest chunk on the stream.
                          	//
                          	// *
                          	// AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk.
                          	//
                          	// *
                          	// AWS_KINESISVIDEO_SERVER_TIMESTAMP - Server timestamp of the fragment.
                          	//
                          	// *
                          	// AWS_KINESISVIDEO_PRODUCER_TIMESTAMP - Producer timestamp of the fragment.
                          	//
                          	// The
                          	// following tags will be present if an error occurs:
                          	//
                          	// *
                          	// AWS_KINESISVIDEO_ERROR_CODE - String description of an error that caused
                          	// GetMedia to stop.
                          	//
                          	// * AWS_KINESISVIDEO_ERROR_ID: Integer code of the error.
                          	//
                          	// The
                          	// error codes are as follows:
                          	//
                          	// * 3002 - Error writing to the stream
                          	//
                          	// * 4000 -
                          	// Requested fragment is not found
                          	//
                          	// * 4500 - Access denied for the stream's KMS
                          	// key
                          	//
                          	// * 4501 - Stream's KMS key is disabled
                          	//
                          	// * 4502 - Validation error on the
                          	// stream's KMS key
                          	//
                          	// * 4503 - KMS key specified in the stream is unavailable
                          	//
                          	// *
                          	// 4504 - Invalid usage of the KMS key specified in the stream
                          	//
                          	// * 4505 - Invalid
                          	// state of the KMS key specified in the stream
                          	//
                          	// * 4506 - Unable to find the KMS
                          	// key specified in the stream
                          	//
                          	// * 5000 - Internal error
                          	Payload io.ReadCloser
                          
                          	// Metadata pertaining to the operation's result.
                          	ResultMetadata middleware.Metadata
                          }

                          type HTTPClient

                          type HTTPClient interface {
                          	Do(*http.Request) (*http.Response, error)
                          }

                          type HTTPSignerV4

                          type HTTPSignerV4 interface {
                          	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
                          }

                          type Options

                          type Options struct {
                          	// Set of options to modify how an operation is invoked. These apply to all
                          	// operations invoked for this client. Use functional options on operation call to
                          	// modify this list for per operation behavior.
                          	APIOptions []func(*middleware.Stack) error
                          
                          	// Configures the events that will be sent to the configured logger.
                          	ClientLogMode aws.ClientLogMode
                          
                          	// The credentials object to use when signing requests.
                          	Credentials aws.CredentialsProvider
                          
                          	// The endpoint options to be used when attempting to resolve an endpoint.
                          	EndpointOptions EndpointResolverOptions
                          
                          	// The service endpoint resolver.
                          	EndpointResolver EndpointResolver
                          
                          	// Signature Version 4 (SigV4) Signer
                          	HTTPSignerV4 HTTPSignerV4
                          
                          	// The logger writer interface to write logging messages to.
                          	Logger logging.Logger
                          
                          	// The region to send requests to. (Required)
                          	Region string
                          
                          	// Retryer guides how HTTP requests should be retried in case of recoverable
                          	// failures. When nil the API client will use a default retryer.
                          	Retryer aws.Retryer
                          
                          	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                          	// implementation if nil.
                          	HTTPClient HTTPClient
                          }

                          func (Options) Copy

                          func (o Options) Copy() Options

                            Copy creates a clone where the APIOptions list is deep copied.

                            type ResolveEndpoint

                            type ResolveEndpoint struct {
                            	Resolver EndpointResolver
                            	Options  EndpointResolverOptions
                            }

                            func (*ResolveEndpoint) HandleSerialize

                            func (*ResolveEndpoint) ID

                            func (*ResolveEndpoint) ID() string

                            Directories

                            Path Synopsis
                            internal