kinesisvideomedia

package
v0.7.0 Latest Latest
Warning

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

 Go to latest Published: Jan 3, 2019 License: Apache-2.0 Imports: 7 Imported by: 16

Documentation

Overview

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

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

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

Using the Client

To Amazon Kinesis Video Streams 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 Media client KinesisVideoMedia for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/kinesisvideomedia/#New

Index

Constants

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"

	// ErrCodeConnectionLimitExceededException for service response error code
	// "ConnectionLimitExceededException".
	//
	// Kinesis Video Streams has throttled the request because you have exceeded
	// the limit of allowed client connections.
	ErrCodeConnectionLimitExceededException = "ConnectionLimitExceededException"

	// ErrCodeInvalidArgumentException for service response error code
	// "InvalidArgumentException".
	//
	// The value for this input parameter is invalid.
	ErrCodeInvalidArgumentException = "InvalidArgumentException"

	// ErrCodeInvalidEndpointException for service response error code
	// "InvalidEndpointException".
	//
	// Status Code: 400, Caller used wrong endpoint to write data to a stream. On
	// receiving such an exception, the user must call GetDataEndpoint with AccessMode
	// set to "READ" and use the endpoint Kinesis Video returns in the next GetMedia
	// call.
	ErrCodeInvalidEndpointException = "InvalidEndpointException"

	// 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".
	//
	// Status Code: 404, The stream with the given name does not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)
View Source 
const (
	ServiceName = "kinesisvideo" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName    // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type GetMediaInput 

type GetMediaInput struct {

	// Identifies the starting chunk to get from the specified stream.
	//
	// StartSelector is a required field
	StartSelector *StartSelector `type:"structure" required:"true"`

	// 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 `min:"1" type:"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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-media-2017-09-30/GetMediaInput

func (GetMediaInput) GoString 

func (s GetMediaInput) GoString() string

GoString returns the string representation

func (GetMediaInput) MarshalFields added in v0.3.0 

func (s GetMediaInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetMediaInput) String 

func (s GetMediaInput) String() string

String returns the string representation

func (*GetMediaInput) Validate 

func (s *GetMediaInput) Validate() error

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

type GetMediaOutput 

type GetMediaOutput struct {

	// The content type of the requested media.
	ContentType *string `location:"header" locationName:"Content-Type" min:"1" type:"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 time stamp of the fragment.
	//
	//    * AWS_KINESISVIDEO_PRODUCER_TIMESTAMP - Producer time stamp 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 `type:"blob"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-media-2017-09-30/GetMediaOutput

func (GetMediaOutput) GoString 

func (s GetMediaOutput) GoString() string

GoString returns the string representation

func (GetMediaOutput) MarshalFields added in v0.3.0 

func (s GetMediaOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetMediaOutput) SDKResponseMetadata 

func (s GetMediaOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetMediaOutput) String 

func (s GetMediaOutput) String() string

String returns the string representation

type GetMediaRequest 

type GetMediaRequest struct {
	*aws.Request
	Input *GetMediaInput
	Copy  func(*GetMediaInput) GetMediaRequest
}

GetMediaRequest is a API request type for the GetMedia API operation.

func (GetMediaRequest) Send 

func (r GetMediaRequest) Send() (*GetMediaOutput, error)

Send marshals and sends the GetMedia API request.

type KinesisVideoMedia 

type KinesisVideoMedia struct {
	*aws.Client
}

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

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

func New 

func New(config aws.Config) *KinesisVideoMedia

New creates a new instance of the KinesisVideoMedia client with a config.

Example: 

// Create a KinesisVideoMedia client from just a config.
svc := kinesisvideomedia.New(myConfig)

func (*KinesisVideoMedia) GetMediaRequest 

func (c *KinesisVideoMedia) GetMediaRequest(input *GetMediaInput) GetMediaRequest

GetMediaRequest returns a request value for making API operation for Amazon Kinesis Video Streams Media.

Use this API to retrieve media content from a Kinesis video stream. In the request, you identify 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 to which you can then send the GetMedia requests.

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

    // Example sending a request using the GetMediaRequest method. req := client.GetMediaRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-media-2017-09-30/GetMedia

type StartSelector 

type StartSelector struct {

	// Specifies the fragment number from where you want the GetMedia API to start
	// returning the fragments.
	AfterFragmentNumber *string `min:"1" type:"string"`

	// Continuation token that Kinesis Video Streams returned in the previous GetMedia
	// response. The GetMedia API then starts with the chunk identified by the continuation
	// token.
	ContinuationToken *string `min:"1" type:"string"`

	// Identifies the fragment on the Kinesis video stream where you want to start
	// getting the data from.
	//
	//    * NOW - Start with the latest chunk on the stream.
	//
	//    * EARLIEST - Start with earliest available chunk on the stream.
	//
	//    * FRAGMENT_NUMBER - Start with the chunk containing the specific fragment.
	//    You must also specify the StartFragmentNumber.
	//
	//    * PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing
	//    a fragment with the specified producer or server time stamp. You specify
	//    the time stamp by adding StartTimestamp.
	//
	//    *  CONTINUATION_TOKEN - Read using the specified continuation token.
	//
	// If you choose the NOW, EARLIEST, or CONTINUATION_TOKEN as the startSelectorType,
	// you don't provide any additional information in the startSelector.
	//
	// StartSelectorType is a required field
	StartSelectorType StartSelectorType `type:"string" required:"true" enum:"true"`

	// A time stamp value. This value is required if you choose the PRODUCER_TIMESTAMP
	// or the SERVER_TIMESTAMP as the startSelectorType. The GetMedia API then starts
	// with the chunk containing the fragment that has the specified time stamp.
	StartTimestamp *time.Time `type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

Identifies the chunk on the Kinesis video stream where you want the GetMedia API to start returning media data. You have the following options to identify the starting chunk:

  • Choose the latest (or oldest) chunk.

  • Identify a specific chunk. You can identify a specific chunk either by providing a fragment number or time stamp (server or producer).

  • Each chunk's metadata includes a continuation token as a Matroska (MKV) tag (AWS_KINESISVIDEO_CONTINUATION_TOKEN). If your previous GetMedia request terminated, you can use this tag value in your next GetMedia request. The API then starts returning chunks starting where the last API ended.

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-media-2017-09-30/StartSelector

func (StartSelector) GoString 

func (s StartSelector) GoString() string

GoString returns the string representation

func (StartSelector) MarshalFields added in v0.3.0 

func (s StartSelector) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StartSelector) String 

func (s StartSelector) String() string

String returns the string representation

func (*StartSelector) Validate 

func (s *StartSelector) Validate() error

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

type StartSelectorType 

type StartSelectorType string
const (
	StartSelectorTypeFragmentNumber    StartSelectorType = "FRAGMENT_NUMBER"
	StartSelectorTypeServerTimestamp   StartSelectorType = "SERVER_TIMESTAMP"
	StartSelectorTypeProducerTimestamp StartSelectorType = "PRODUCER_TIMESTAMP"
	StartSelectorTypeNow               StartSelectorType = "NOW"
	StartSelectorTypeEarliest          StartSelectorType = "EARLIEST"
	StartSelectorTypeContinuationToken StartSelectorType = "CONTINUATION_TOKEN"
)

Enum values for StartSelectorType

func (StartSelectorType) MarshalValue added in v0.3.0 

func (enum StartSelectorType) MarshalValue() (string, error)

func (StartSelectorType) MarshalValueBuf added in v0.3.0 

func (enum StartSelectorType) MarshalValueBuf(b []byte) ([]byte, error)

Source Files

View all Source files

Directories

Path Synopsis
Package kinesisvideomediaiface provides an interface to enable mocking the Amazon Kinesis Video Streams Media service client for testing your code.
 Package kinesisvideomediaiface provides an interface to enable mocking the Amazon Kinesis Video Streams 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.