Documentation

Overview

    Package kinesisvideosignaling provides the API client, operations, and parameter types for 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.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2019-12-04"
    View Source
    const ServiceID = "Kinesis Video Signaling"

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

            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) GetIceServerConfig

                func (c *Client) GetIceServerConfig(ctx context.Context, params *GetIceServerConfigInput, optFns ...func(*Options)) (*GetIceServerConfigOutput, error)

                  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.

                  func (*Client) SendAlexaOfferToMaster

                  func (c *Client) SendAlexaOfferToMaster(ctx context.Context, params *SendAlexaOfferToMasterInput, optFns ...func(*Options)) (*SendAlexaOfferToMasterOutput, error)

                    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.

                    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 GetIceServerConfigInput

                            type GetIceServerConfigInput struct {
                            
                            	// The ARN of the signaling channel to be used for the peer-to-peer connection
                            	// between configured peers.
                            	//
                            	// This member is required.
                            	ChannelARN *string
                            
                            	// Unique identifier for the viewer. Must be unique within the signaling channel.
                            	ClientId *string
                            
                            	// Specifies the desired service. Currently, TURN is the only valid value.
                            	Service types.Service
                            
                            	// An optional user ID to be associated with the credentials.
                            	Username *string
                            }

                            type GetIceServerConfigOutput

                            type GetIceServerConfigOutput struct {
                            
                            	// The list of ICE server information objects.
                            	IceServerList []types.IceServer
                            
                            	// 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

                              type SendAlexaOfferToMasterInput

                              type SendAlexaOfferToMasterInput struct {
                              
                              	// The ARN of the signaling channel by which Alexa and the master peer communicate.
                              	//
                              	// This member is required.
                              	ChannelARN *string
                              
                              	// The base64-encoded SDP offer content.
                              	//
                              	// This member is required.
                              	MessagePayload *string
                              
                              	// The unique identifier for the sender client.
                              	//
                              	// This member is required.
                              	SenderClientId *string
                              }

                              type SendAlexaOfferToMasterOutput

                              type SendAlexaOfferToMasterOutput struct {
                              
                              	// The base64-encoded SDP answer content.
                              	Answer *string
                              
                              	// Metadata pertaining to the operation's result.
                              	ResultMetadata middleware.Metadata
                              }

                              Directories

                              Path Synopsis
                              internal