AWS ivs documentation change
Summary
Updated multiple links to GetClientConfiguration and FindIngest API references by adding an extra slash in the URL path
Security assessment
The changes are purely URL formatting updates without any security context. No vulnerabilities, security features, or security implications are mentioned in the diff.
Diff
diff --git a/ivs/latest/LowLatencyUserGuide/multitrack-video-sw-integration.md b/ivs/latest/LowLatencyUserGuide/multitrack-video-sw-integration.md index 04fed1353..f2cdd060e 100644 --- a//ivs/latest/LowLatencyUserGuide/multitrack-video-sw-integration.md +++ b//ivs/latest/LowLatencyUserGuide/multitrack-video-sw-integration.md @@ -51 +51 @@ When a user starts streaming, your software must query information about the use -[GetClientConfiguration](https://docs.aws.amazon.com/ivs/latest//BroadcastSWIntegAPIReference/actions-GetClientConfiguration.html) requires information about the user’s hardware and software setup. +[GetClientConfiguration](https://docs.aws.amazon.com//ivs/latest//BroadcastSWIntegAPIReference/actions-GetClientConfiguration.html) requires information about the user’s hardware and software setup. @@ -138 +138 @@ _Errors_ are considered fatal. The user should not be permitted to continue stre -[GetClientConfiguration](https://docs.aws.amazon.com/ivs/latest//BroadcastSWIntegAPIReference/actions-GetClientConfiguration.html) returns scaling and encoding settings that optimize for the best possible viewer experience, without impacting the performance of the application (e.g., game/broadcast software) and taking into account the user’s settings. Use the exact scaling and encoding settings returned by GetClientConfiguration. GetClientConfiguration takes into account the specific needs of different vendors and GPU architectures that change over time. +[GetClientConfiguration](https://docs.aws.amazon.com//ivs/latest//BroadcastSWIntegAPIReference/actions-GetClientConfiguration.html) returns scaling and encoding settings that optimize for the best possible viewer experience, without impacting the performance of the application (e.g., game/broadcast software) and taking into account the user’s settings. Use the exact scaling and encoding settings returned by GetClientConfiguration. GetClientConfiguration takes into account the specific needs of different vendors and GPU architectures that change over time. @@ -159 +159 @@ When connecting with enhanced RTMP, Amazon IVS multitrack video has several requ - * The stream key in the `authentication` field returned by [GetClientConfiguration](https://docs.aws.amazon.com/ivs/latest//BroadcastSWIntegAPIReference/actions-GetClientConfiguration.html) must be used to connect to the RTMP server. + * The stream key in the `authentication` field returned by [GetClientConfiguration](https://docs.aws.amazon.com//ivs/latest//BroadcastSWIntegAPIReference/actions-GetClientConfiguration.html) must be used to connect to the RTMP server. @@ -161 +161 @@ When connecting with enhanced RTMP, Amazon IVS multitrack video has several requ - * The `config_id` value returned by [GetClientConfiguration](https://docs.aws.amazon.com/ivs/latest//BroadcastSWIntegAPIReference/actions-GetClientConfiguration.html) must be appended as a query argument to the RTMP connection string with key `clientConfigId`. + * The `config_id` value returned by [GetClientConfiguration](https://docs.aws.amazon.com//ivs/latest//BroadcastSWIntegAPIReference/actions-GetClientConfiguration.html) must be appended as a query argument to the RTMP connection string with key `clientConfigId`. @@ -175 +175 @@ Multitrack | OneTrack | 3 | 640x360 -Your broadcast software should use the data returned by [GetClientConfiguration](https://docs.aws.amazon.com/ivs/latest//BroadcastSWIntegAPIReference/actions-GetClientConfiguration.html) in `ingest_endpoints` and the protocol (RTMP or RTMPS) selected by the user to identify the endpoint to connect to. Use the `url_template` and the stream key returned in `authentication` to create a URL and include `config_id` as the `clientConfigId` query argument. If you allow the user to specify RTMP query arguments (for example, `?bandwidthtest=1`), you must append them in addition to specifying `clientConfigId`. Here is an example of a response from GetClientConfiguration: +Your broadcast software should use the data returned by [GetClientConfiguration](https://docs.aws.amazon.com//ivs/latest//BroadcastSWIntegAPIReference/actions-GetClientConfiguration.html) in `ingest_endpoints` and the protocol (RTMP or RTMPS) selected by the user to identify the endpoint to connect to. Use the `url_template` and the stream key returned in `authentication` to create a URL and include `config_id` as the `clientConfigId` query argument. If you allow the user to specify RTMP query arguments (for example, `?bandwidthtest=1`), you must append them in addition to specifying `clientConfigId`. Here is an example of a response from GetClientConfiguration: @@ -218 +218 @@ The video system disconnects the client in several scenarios: - * The client tries to connect to the RTMP server with multitrack video but does not use the stream key returned by [GetClientConfiguration](https://docs.aws.amazon.com/ivs/latest//BroadcastSWIntegAPIReference/actions-GetClientConfiguration.html). + * The client tries to connect to the RTMP server with multitrack video but does not use the stream key returned by [GetClientConfiguration](https://docs.aws.amazon.com//ivs/latest//BroadcastSWIntegAPIReference/actions-GetClientConfiguration.html). @@ -346 +346 @@ See Using a FindIngest Server for Auto Streaming Destination for more informatio -When users are configuring their streaming destinations, you should query [FindIngest](https://docs.aws.amazon.com/ivs/latest//BroadcastSWIntegAPIReference/actions-FindIngest.html) and provide the user with the ability to: +When users are configuring their streaming destinations, you should query [FindIngest](https://docs.aws.amazon.com//ivs/latest//BroadcastSWIntegAPIReference/actions-FindIngest.html) and provide the user with the ability to: @@ -352 +352 @@ When users are configuring their streaming destinations, you should query [FindI - * Select a specific server from the list returned by [FindIngest](https://docs.aws.amazon.com/ivs/latest//BroadcastSWIntegAPIReference/actions-FindIngest.html) + * Select a specific server from the list returned by [FindIngest](https://docs.aws.amazon.com//ivs/latest//BroadcastSWIntegAPIReference/actions-FindIngest.html) @@ -388 +388 @@ When **Specify Custom Server** is selected, a text box is provided for the user -If you use ingest endpoints specified by FindIngest when Auto was specified for the streaming destination, use the entry with the lowest `priority` value returned by [FindIngest](https://docs.aws.amazon.com/ivs/latest//BroadcastSWIntegAPIReference/actions-FindIngest.html). To reduce the time it takes for a stream to go live, you may cache the FindIngest response. If you do cache the response, update the cached value regularly. +If you use ingest endpoints specified by FindIngest when Auto was specified for the streaming destination, use the entry with the lowest `priority` value returned by [FindIngest](https://docs.aws.amazon.com//ivs/latest//BroadcastSWIntegAPIReference/actions-FindIngest.html). To reduce the time it takes for a stream to go live, you may cache the FindIngest response. If you do cache the response, update the cached value regularly.