From 08bb91e047ba01f7a069ea8d27ad81d78250b44f Mon Sep 17 00:00:00 2001 From: Alun Fryer <133015887+afryer-ross@users.noreply.github.com> Date: Wed, 5 Jun 2024 10:01:09 -0400 Subject: [PATCH] Add note about special characters in NDI names --- docs/Overview.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Overview.md b/docs/Overview.md index fbc5388..82ed054 100644 --- a/docs/Overview.md +++ b/docs/Overview.md @@ -225,7 +225,7 @@ The name of the Native NDI Sender stream in the NDI domain. This property MUST N A controller MAY modify this parameter within the supported constraints of the Sender. -> Informative note: In the NDI domain, the `source_name` and `machine_name` are concatenated in the format `machine_name (source_name)` when streams are discovered and connected, however in the `transport_params`, these properties are kept independent. +> Informative note: In the NDI domain, the `source_name` and `machine_name` are concatenated in the format `machine_name (source_name)` when streams are discovered and connected, however in the `transport_params`, these properties are kept independent. Certain characters are not supported by the NDI SDK. A device can place constraints to restrict the use of specific characters. #### source_url The URL of the Native NDI Sender as utilized by the NDI SDK. The contents are proprietary to the NDI SDK and interpretation is not recommended. If unspecified, it MUST be set to `null`. Senders MUST constrain this parameter with appropriate values. @@ -270,7 +270,7 @@ The name of the Native NDI Sender stream in the NDI domain that is to be connect A controller MUST specify `source_name` when making a connection. -> Informative notes: In the NDI domain, the `source_name` and `machine_name` are concatenated in the format `machine_name (source_name)` when streams are discovered and connected, however in the `transport_params`, these properties are kept independent. +> Informative notes: In the NDI domain, the `source_name` and `machine_name` are concatenated in the format `machine_name (source_name)` when streams are discovered and connected, however in the `transport_params`, these properties are kept independent. Certain characters are not supported by the NDI SDK. A device can place constraints to restrict the use of specific characters. #### source_url The URL of the NDI Native Sender as utilized by the NDI SDK. The contents are proprietary to the NDI SDK and SHOULD NOT be interpreted.