kinesisvideosignaling

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 7 Imported by: 6

Documentation

Overview

Package kinesisvideosignaling provides the client and types for making API requests to Amazon Kinesis Video Signaling Channels.

Kinesis Video Streams Signaling Service is a intermediate service that establishes a communication channel for discovering peers, transmitting offers and answers in order to establish peer-to-peer connection in webRTC technology.

See https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-signaling-2019-12-04 for more information on this service.

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

Using the Client

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

Index

Constants

View Source 
const (
	ServiceName = "Amazon Kinesis Video Signaling Channels" // Service's name
	ServiceID   = "KinesisVideoSignaling"                   // Service's identifier
	EndpointsID = "kinesisvideo"                            // Service's Endpoint identifier
)
View Source 
const (

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

	// ErrCodeInvalidClientException for service response error code
	// "InvalidClientException".
	//
	// The specified client is invalid.
	ErrCodeInvalidClientException = "InvalidClientException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// Your request was throttled because you have exceeded the limit of allowed
	// client calls. Try making the call later.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeNotAuthorizedException for service response error code
	// "NotAuthorizedException".
	//
	// The caller is not authorized to perform this operation.
	ErrCodeNotAuthorizedException = "NotAuthorizedException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource is not found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeSessionExpiredException for service response error code
	// "SessionExpiredException".
	//
	// If the client session is expired. Once the client is connected, the session
	// is valid for 45 minutes. Client should reconnect to the channel to continue
	// sending/receiving messages.
	ErrCodeSessionExpiredException = "SessionExpiredException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to Amazon Kinesis Video Signaling Channels. See this package's package overview docs for details on the service.

The client's 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) *Client

New creates a new instance of the client from the provided Config.

Example: 

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

func (*Client) GetIceServerConfigRequest 

func (c *Client) GetIceServerConfigRequest(input *GetIceServerConfigInput) GetIceServerConfigRequest

GetIceServerConfigRequest returns a request value for making API operation for Amazon Kinesis Video Signaling Channels.

Gets the Interactive Connectivity Establishment (ICE) server configuration information, including URIs, username, and password which can be used to configure the WebRTC connection. The ICE component uses this configuration information to setup the WebRTC connection, including authenticating with the Traversal Using Relays around NAT (TURN) relay server.

TURN is a protocol that is used to improve the connectivity of peer-to-peer applications. By providing a cloud-based relay service, TURN ensures that a connection can be established even when one or more peers are incapable of a direct peer-to-peer connection. For more information, see A REST API For Access To TURN Services (https://tools.ietf.org/html/draft-uberti-rtcweb-turn-rest-00).

You can invoke this API to establish a fallback mechanism in case either of the peers is unable to establish a direct peer-to-peer connection over a signaling channel. You must specify either a signaling channel ARN or the client ID in order to invoke this API. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-signaling-2019-12-04/GetIceServerConfig

func (*Client) SendAlexaOfferToMasterRequest 

func (c *Client) SendAlexaOfferToMasterRequest(input *SendAlexaOfferToMasterInput) SendAlexaOfferToMasterRequest

SendAlexaOfferToMasterRequest returns a request value for making API operation for Amazon Kinesis Video Signaling Channels.

This API allows you to connect WebRTC-enabled devices with Alexa display devices. When invoked, it sends the Alexa Session Description Protocol (SDP) offer to the master peer. The offer is delivered as soon as the master is connected to the specified signaling channel. This API returns the SDP answer from the connected master. If the master is not connected to the signaling channel, redelivery requests are made until the message expires. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster

type GetIceServerConfigInput 

type GetIceServerConfigInput struct {

	// The ARN of the signaling channel to be used for the peer-to-peer connection
	// between configured peers.
	//
	// ChannelARN is a required field
	ChannelARN *string `min:"1" type:"string" required:"true"`

	// Unique identifier for the viewer. Must be unique within the signaling channel.
	ClientId *string `min:"1" type:"string"`

	// Specifies the desired service. Currently, TURN is the only valid value.
	Service Service `type:"string" enum:"true"`

	// An optional user ID to be associated with the credentials.
	Username *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetIceServerConfigInput) MarshalFields 

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

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

func (GetIceServerConfigInput) String 

func (s GetIceServerConfigInput) String() string

String returns the string representation

func (*GetIceServerConfigInput) Validate 

func (s *GetIceServerConfigInput) Validate() error

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

type GetIceServerConfigOutput 

type GetIceServerConfigOutput struct {

	// The list of ICE server information objects.
	IceServerList []IceServer `type:"list"`
	// contains filtered or unexported fields
}

func (GetIceServerConfigOutput) MarshalFields 

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

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

func (GetIceServerConfigOutput) String 

func (s GetIceServerConfigOutput) String() string

String returns the string representation

type GetIceServerConfigRequest 

type GetIceServerConfigRequest struct {
	*aws.Request
	Input *GetIceServerConfigInput
	Copy  func(*GetIceServerConfigInput) GetIceServerConfigRequest
}

GetIceServerConfigRequest is the request type for the GetIceServerConfig API operation.

func (GetIceServerConfigRequest) Send 

func (r GetIceServerConfigRequest) Send(ctx context.Context) (*GetIceServerConfigResponse, error)

Send marshals and sends the GetIceServerConfig API request.

type GetIceServerConfigResponse 

type GetIceServerConfigResponse struct {
	*GetIceServerConfigOutput
	// contains filtered or unexported fields
}

GetIceServerConfigResponse is the response type for the GetIceServerConfig API operation.

func (*GetIceServerConfigResponse) SDKResponseMetdata 

func (r *GetIceServerConfigResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetIceServerConfig request.

type IceServer 

type IceServer struct {

	// A password to login to the ICE server.
	Password *string `min:"1" type:"string"`

	// The period of time, in seconds, during which the username and password are
	// valid.
	Ttl *int64 `min:"30" type:"integer"`

	// An array of URIs, in the form specified in the I-D.petithuguenin-behave-turn-uris
	// (https://tools.ietf.org/html/draft-petithuguenin-behave-turn-uris-03) spec.
	// These URIs provide the different addresses and/or protocols that can be used
	// to reach the TURN server.
	Uris []string `type:"list"`

	// A username to login to the ICE server.
	Username *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A structure for the ICE server connection data.

func (IceServer) MarshalFields 

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

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

func (IceServer) String 

func (s IceServer) String() string

String returns the string representation

type SendAlexaOfferToMasterInput 

type SendAlexaOfferToMasterInput struct {

	// The ARN of the signaling channel by which Alexa and the master peer communicate.
	//
	// ChannelARN is a required field
	ChannelARN *string `min:"1" type:"string" required:"true"`

	// The base64-encoded SDP offer content.
	//
	// MessagePayload is a required field
	MessagePayload *string `min:"1" type:"string" required:"true"`

	// The unique identifier for the sender client.
	//
	// SenderClientId is a required field
	SenderClientId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (SendAlexaOfferToMasterInput) MarshalFields 

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

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

func (SendAlexaOfferToMasterInput) String 

func (s SendAlexaOfferToMasterInput) String() string

String returns the string representation

func (*SendAlexaOfferToMasterInput) Validate 

func (s *SendAlexaOfferToMasterInput) Validate() error

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

type SendAlexaOfferToMasterOutput 

type SendAlexaOfferToMasterOutput struct {

	// The base64-encoded SDP answer content.
	Answer *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (SendAlexaOfferToMasterOutput) MarshalFields 

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

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

func (SendAlexaOfferToMasterOutput) String 

func (s SendAlexaOfferToMasterOutput) String() string

String returns the string representation

type SendAlexaOfferToMasterRequest 

type SendAlexaOfferToMasterRequest struct {
	*aws.Request
	Input *SendAlexaOfferToMasterInput
	Copy  func(*SendAlexaOfferToMasterInput) SendAlexaOfferToMasterRequest
}

SendAlexaOfferToMasterRequest is the request type for the SendAlexaOfferToMaster API operation.

func (SendAlexaOfferToMasterRequest) Send 

func (r SendAlexaOfferToMasterRequest) Send(ctx context.Context) (*SendAlexaOfferToMasterResponse, error)

Send marshals and sends the SendAlexaOfferToMaster API request.

type SendAlexaOfferToMasterResponse 

type SendAlexaOfferToMasterResponse struct {
	*SendAlexaOfferToMasterOutput
	// contains filtered or unexported fields
}

SendAlexaOfferToMasterResponse is the response type for the SendAlexaOfferToMaster API operation.

func (*SendAlexaOfferToMasterResponse) SDKResponseMetdata 

func (r *SendAlexaOfferToMasterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the SendAlexaOfferToMaster request.

type Service 

type Service string
const (
	ServiceTurn Service = "TURN"
)

Enum values for Service

func (Service) MarshalValue 

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

func (Service) MarshalValueBuf 

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

Source Files

View all Source files

Directories

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