GetStreamSession TCL Example
load ./chilkat.dll
# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set rest [new_CkRest]
set authAws [new_CkAuthAws]
CkAuthAws_put_AccessKey $authAws "AWS_ACCESS_KEY"
CkAuthAws_put_SecretKey $authAws "AWS_SECRET_KEY"
# Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
CkAuthAws_put_Region $authAws "us-west-2"
CkAuthAws_put_ServiceName $authAws "ivs"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest_SetAuthAws $rest $authAws
# URL: https://ivs.us-west-2.amazonaws.com/
# Use the same region as specified above.
set success [CkRest_Connect $rest "ivs.us-west-2.amazonaws.com" 443 1 1]
if {$success != 1} then {
puts "ConnectFailReason: [CkRest_get_ConnectFailReason $rest]"
puts [CkRest_lastErrorText $rest]
delete_CkRest $rest
delete_CkAuthAws $authAws
exit
}
# The following code creates the JSON request body.
# The JSON created by this code is shown below.
# Use this online tool to generate code from sample JSON:
# Generate Code to Create JSON
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "channelArn" "string"
CkJsonObject_UpdateString $json "streamId" "string"
# The JSON request body created by the above code:
# {
# "channelArn": "string",
# "streamId": "string"
# }
CkRest_AddHeader $rest "Content-Type" "application/x-amz-json-1.1"
CkRest_AddHeader $rest "X-Amz-Target" "GetStreamSession"
set sbRequestBody [new_CkStringBuilder]
CkJsonObject_EmitSb $json $sbRequestBody
set sbResponseBody [new_CkStringBuilder]
set success [CkRest_FullRequestSb $rest "POST" "/GetStreamSession" $sbRequestBody $sbResponseBody]
if {$success != 1} then {
puts [CkRest_lastErrorText $rest]
delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
exit
}
set respStatusCode [CkRest_get_ResponseStatusCode $rest]
puts "response status code = $respStatusCode"
if {$respStatusCode != 200} then {
puts "Response Header:"
puts [CkRest_responseHeader $rest]
puts "Response Body:"
puts [CkStringBuilder_getAsString $sbResponseBody]
delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
# The following code parses the JSON response.
# A sample JSON response is shown below the sample code.
# Use this online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON
set Arn [CkJsonObject_stringOf $jResp "streamSession.channel.arn"]
set Authorized [CkJsonObject_IntOf $jResp "streamSession.channel.authorized"]
set IngestEndpoint [CkJsonObject_stringOf $jResp "streamSession.channel.ingestEndpoint"]
set LatencyMode [CkJsonObject_stringOf $jResp "streamSession.channel.latencyMode"]
set Name [CkJsonObject_stringOf $jResp "streamSession.channel.name"]
set PlaybackUrl [CkJsonObject_stringOf $jResp "streamSession.channel.playbackUrl"]
set RecordingConfigurationArn [CkJsonObject_stringOf $jResp "streamSession.channel.recordingConfigurationArn"]
set v_String [CkJsonObject_stringOf $jResp "streamSession.channel.tags.string"]
set v_Type [CkJsonObject_stringOf $jResp "streamSession.channel.type"]
set EndTime [CkJsonObject_IntOf $jResp "streamSession.endTime"]
set Channels [CkJsonObject_IntOf $jResp "streamSession.ingestConfiguration.audio.channels"]
set Codec [CkJsonObject_stringOf $jResp "streamSession.ingestConfiguration.audio.codec"]
set SampleRate [CkJsonObject_IntOf $jResp "streamSession.ingestConfiguration.audio.sampleRate"]
set TargetBitrate [CkJsonObject_IntOf $jResp "streamSession.ingestConfiguration.audio.targetBitrate"]
set AvcLevel [CkJsonObject_stringOf $jResp "streamSession.ingestConfiguration.video.avcLevel"]
set AvcProfile [CkJsonObject_stringOf $jResp "streamSession.ingestConfiguration.video.avcProfile"]
set VideoCodec [CkJsonObject_stringOf $jResp "streamSession.ingestConfiguration.video.codec"]
set Encoder [CkJsonObject_stringOf $jResp "streamSession.ingestConfiguration.video.encoder"]
set VideoTargetBitrate [CkJsonObject_IntOf $jResp "streamSession.ingestConfiguration.video.targetBitrate"]
set TargetFramerate [CkJsonObject_IntOf $jResp "streamSession.ingestConfiguration.video.targetFramerate"]
set VideoHeight [CkJsonObject_IntOf $jResp "streamSession.ingestConfiguration.video.videoHeight"]
set VideoWidth [CkJsonObject_IntOf $jResp "streamSession.ingestConfiguration.video.videoWidth"]
set RecordingConfigurationArn [CkJsonObject_stringOf $jResp "streamSession.recordingConfiguration.arn"]
set BucketName [CkJsonObject_stringOf $jResp "streamSession.recordingConfiguration.destinationConfiguration.s3.bucketName"]
set RecordingConfigurationName [CkJsonObject_stringOf $jResp "streamSession.recordingConfiguration.name"]
set State [CkJsonObject_stringOf $jResp "streamSession.recordingConfiguration.state"]
set TagsString [CkJsonObject_stringOf $jResp "streamSession.recordingConfiguration.tags.string"]
set RecordingMode [CkJsonObject_stringOf $jResp "streamSession.recordingConfiguration.thumbnailConfiguration.recordingMode"]
set TargetIntervalSeconds [CkJsonObject_IntOf $jResp "streamSession.recordingConfiguration.thumbnailConfiguration.targetIntervalSeconds"]
set StartTime [CkJsonObject_IntOf $jResp "streamSession.startTime"]
set StreamId [CkJsonObject_stringOf $jResp "streamSession.streamId"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "streamSession.truncatedEvents"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set eventTime [CkJsonObject_IntOf $jResp "streamSession.truncatedEvents[i].eventTime"]
set name [CkJsonObject_stringOf $jResp "streamSession.truncatedEvents[i].name"]
set v_type [CkJsonObject_stringOf $jResp "streamSession.truncatedEvents[i].type"]
set i [expr $i + 1]
}
# A sample JSON response body parsed by the above code:
# {
# "streamSession": {
# "channel": {
# "arn": "string",
# "authorized": boolean,
# "ingestEndpoint": "string",
# "latencyMode": "string",
# "name": "string",
# "playbackUrl": "string",
# "recordingConfigurationArn": "string",
# "tags": {
# "string": "string"
# },
# "type": "string"
# },
# "endTime": number,
# "ingestConfiguration": {
# "audio": {
# "channels": number,
# "codec": "string",
# "sampleRate": number,
# "targetBitrate": number
# },
# "video": {
# "avcLevel": "string",
# "avcProfile": "string",
# "codec": "string",
# "encoder": "string",
# "targetBitrate": number,
# "targetFramerate": number,
# "videoHeight": number,
# "videoWidth": number
# }
# },
# "recordingConfiguration": {
# "arn": "string",
# "destinationConfiguration": {
# "s3": {
# "bucketName": "string"
# }
# },
# "name": "string",
# "state": "string",
# "tags": {
# "string": "string"
# },
# "thumbnailConfiguration": {
# "recordingMode": "string",
# "targetIntervalSeconds": number
# }
# },
# "startTime": number,
# "streamId": "string",
# "truncatedEvents": [
# {
# "eventTime": number,
# "name": "string",
# "type": "string"
# }
# ]
# }
# }
delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp