GetStreamSession PureBasic Example
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkAuthAws.pb"
Procedure ChilkatExample()
; This example requires the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
rest.i = CkRest::ckCreate()
If rest.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
authAws.i = CkAuthAws::ckCreate()
If authAws.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkAuthAws::setCkAccessKey(authAws, "AWS_ACCESS_KEY")
CkAuthAws::setCkSecretKey(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::setCkRegion(authAws, "us-west-2")
CkAuthAws::setCkServiceName(authAws, "ivs")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://ivs.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"ivs.us-west-2.amazonaws.com",443,1,1)
If success <> 1
Debug "ConnectFailReason: " + Str(CkRest::ckConnectFailReason(rest))
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
ProcedureReturn
EndIf
; 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
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"channelArn","string")
CkJsonObject::ckUpdateString(json,"streamId","string")
; The JSON request body created by the above code:
; {
; "channelArn": "string",
; "streamId": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","GetStreamSession")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkRest::ckFullRequestSb(rest,"POST","/GetStreamSession",sbRequestBody,sbResponseBody)
If success <> 1
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
respStatusCode.i = CkRest::ckResponseStatusCode(rest)
Debug "response status code = " + Str(respStatusCode)
If respStatusCode <> 200
Debug "Response Header:"
Debug CkRest::ckResponseHeader(rest)
Debug "Response Body:"
Debug CkStringBuilder::ckGetAsString(sbResponseBody)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(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
eventTime.i
name.s
v_type.s
Arn.s = CkJsonObject::ckStringOf(jResp,"streamSession.channel.arn")
Authorized.i = CkJsonObject::ckIntOf(jResp,"streamSession.channel.authorized")
IngestEndpoint.s = CkJsonObject::ckStringOf(jResp,"streamSession.channel.ingestEndpoint")
LatencyMode.s = CkJsonObject::ckStringOf(jResp,"streamSession.channel.latencyMode")
Name.s = CkJsonObject::ckStringOf(jResp,"streamSession.channel.name")
PlaybackUrl.s = CkJsonObject::ckStringOf(jResp,"streamSession.channel.playbackUrl")
RecordingConfigurationArn.s = CkJsonObject::ckStringOf(jResp,"streamSession.channel.recordingConfigurationArn")
v_String.s = CkJsonObject::ckStringOf(jResp,"streamSession.channel.tags.string")
v_Type.s = CkJsonObject::ckStringOf(jResp,"streamSession.channel.type")
EndTime.i = CkJsonObject::ckIntOf(jResp,"streamSession.endTime")
Channels.i = CkJsonObject::ckIntOf(jResp,"streamSession.ingestConfiguration.audio.channels")
Codec.s = CkJsonObject::ckStringOf(jResp,"streamSession.ingestConfiguration.audio.codec")
SampleRate.i = CkJsonObject::ckIntOf(jResp,"streamSession.ingestConfiguration.audio.sampleRate")
TargetBitrate.i = CkJsonObject::ckIntOf(jResp,"streamSession.ingestConfiguration.audio.targetBitrate")
AvcLevel.s = CkJsonObject::ckStringOf(jResp,"streamSession.ingestConfiguration.video.avcLevel")
AvcProfile.s = CkJsonObject::ckStringOf(jResp,"streamSession.ingestConfiguration.video.avcProfile")
VideoCodec.s = CkJsonObject::ckStringOf(jResp,"streamSession.ingestConfiguration.video.codec")
Encoder.s = CkJsonObject::ckStringOf(jResp,"streamSession.ingestConfiguration.video.encoder")
VideoTargetBitrate.i = CkJsonObject::ckIntOf(jResp,"streamSession.ingestConfiguration.video.targetBitrate")
TargetFramerate.i = CkJsonObject::ckIntOf(jResp,"streamSession.ingestConfiguration.video.targetFramerate")
VideoHeight.i = CkJsonObject::ckIntOf(jResp,"streamSession.ingestConfiguration.video.videoHeight")
VideoWidth.i = CkJsonObject::ckIntOf(jResp,"streamSession.ingestConfiguration.video.videoWidth")
RecordingConfigurationArn = CkJsonObject::ckStringOf(jResp,"streamSession.recordingConfiguration.arn")
BucketName.s = CkJsonObject::ckStringOf(jResp,"streamSession.recordingConfiguration.destinationConfiguration.s3.bucketName")
RecordingConfigurationName.s = CkJsonObject::ckStringOf(jResp,"streamSession.recordingConfiguration.name")
State.s = CkJsonObject::ckStringOf(jResp,"streamSession.recordingConfiguration.state")
TagsString.s = CkJsonObject::ckStringOf(jResp,"streamSession.recordingConfiguration.tags.string")
RecordingMode.s = CkJsonObject::ckStringOf(jResp,"streamSession.recordingConfiguration.thumbnailConfiguration.recordingMode")
TargetIntervalSeconds.i = CkJsonObject::ckIntOf(jResp,"streamSession.recordingConfiguration.thumbnailConfiguration.targetIntervalSeconds")
StartTime.i = CkJsonObject::ckIntOf(jResp,"streamSession.startTime")
StreamId.s = CkJsonObject::ckStringOf(jResp,"streamSession.streamId")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"streamSession.truncatedEvents")
While i < count_i
CkJsonObject::setCkI(jResp, i)
eventTime = CkJsonObject::ckIntOf(jResp,"streamSession.truncatedEvents[i].eventTime")
name = CkJsonObject::ckStringOf(jResp,"streamSession.truncatedEvents[i].name")
v_type = CkJsonObject::ckStringOf(jResp,"streamSession.truncatedEvents[i].type")
i = i + 1
Wend
; 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"
; }
; ]
; }
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
