ndi_document_newdoctemplate (ndi.document class)¶
Class definition¶
Class name: ndi_document_newdoctemplate
Short name: ndi_document_newdoctemplate
Superclasses: ndi_document
Definition: $NDIDOCUMENTPATH/ndi_document_newdoctemplate.json
Schema for validation: $NDISCHEMAPATH/ndi_document_newdoctemplate_schema.json
Property_list_name: newdoctemplate
Class_version: 1
ndi_document_newdoctemplate fields¶
Accessed by newdoctemplate.field where field is one of the field names below
| field | default_value | data type | description |
|---|---|---|---|
| propertyname_1_stringexample | |||
| propertyname_2_number_example | |||
| propertyname_3_array_example | |||
| propertyname_4_stringarray_example |
ndi_document fields¶
Accessed by ndi_document.field where field is one of the field names below
| field | default_value | data type | description |
|---|---|---|---|
| session_id | - | NDI ID string | The globally unique identifier of any data session that produced this document |
| id | - | NDI ID string | The globally unique identifier of this document |
| name | character array (ASCII) | A user-specified name, free for users/developers to use as they like | |
| type | character array (ASCII) | A user-specified type, free for users/developers to use as they like (deprecated, will be removed) | |
| datestamp | (current time) | ISO-8601 date string, time zone must be UTC leap seconds | Time of document creation |
| database_version | - | character array (ASCII) | Version of this document in the database |