Amazon Kinesis Webrtc C SDK
ChannelInfo Struct Reference

Contains all signaling channel related information. More...

#include <Include.h>

Collaboration diagram for ChannelInfo:
Collaboration graph

Public Attributes

UINT32 version
 Version of the structure. More...
 
PCHAR pChannelName
 Name of the signaling channel name. Maximum length is defined by MAX_CHANNEL_NAME_LEN + 1. More...
 
PCHAR pChannelArn
 
PCHAR pStorageStreamArn
 
PCHAR pRegion
 
PCHAR pControlPlaneUrl
 
PCHAR pCertPath
 Optional certificate path. Maximum length is defined by MAX_PATH_LEN+1. More...
 
PCHAR pUserAgentPostfix
 
PCHAR pCustomUserAgent
 Optional custom user agent name. Maximum length is defined by MAX_USER_AGENT_LEN+1. More...
 
PCHAR pUserAgent
 Combined user agent. Maximum length is defined by MAX_USER_AGENT_LEN+1. More...
 
PCHAR pKmsKeyId
 Optional KMS key id ARN. Maximum length is defined by MAX_ARN_LEN+1. More...
 
SIGNALING_CHANNEL_TYPE channelType
 Channel type when creating. More...
 
SIGNALING_CHANNEL_ROLE_TYPE channelRoleType
 Channel role type for the endpoint - master/viewer. More...
 
BOOL reserved
 Reserved field for compatibility. More...
 
UINT64 cachingPeriod
 
BOOL retry
 Flag determines if a retry of the network calls is to be done on errors up to max retry times. More...
 
BOOL reconnect
 Flag determines if reconnection should be attempted on connection drop. More...
 
UINT64 messageTtl
 
UINT32 tagCount
 Number of tags associated with the stream. More...
 
PTag pTags
 Stream tags array. More...
 
SIGNALING_API_CALL_CACHE_TYPE cachingPolicy
 Backend API call caching policy. More...
 
BOOL asyncIceServerConfig
 
BOOL useMediaStorage
 use the feature of media storage. More...
 

Detailed Description

Contains all signaling channel related information.


The documentation for this struct was generated from the following file: