REST IEEE 1722.1 TSN Controller

AudioUnit

decrementAudioUnitExternamPortInputControl

Decrement audioUnit/externalPortInput/control value

The following objects can be changed and trigger AEM Command on the device. *decrement* The **DECREMENT_CONTROL** command is used to decrement the specified values of a Control by the Control’s step sizes. The decrement_control command acts on a CONTROL descriptor in the current Configuration. An Entity may propagate the value change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. Note that the value only determines the index of control value, which is decremented. In response you will receive the current value, which is determined by the controlValueType. The maximum possible index is the value count described in the descriptor. option you can set the format but also have to specify the value count. The count parameter may only be used with the format parameter. Use this if the entity does not describe it with a descriptor. The values may not be displayed correctly.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortInput/{stream_idx}/control/{control_index}/decrement

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortInput/{stream_idx}/control/{control_index}/decrement"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.decrementAudioUnitExternamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#decrementAudioUnitExternamPortInputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.decrementAudioUnitExternamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#decrementAudioUnitExternamPortInputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
CONTROLCREMENT *cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; //  (optional)

// Decrement audioUnit/externalPortInput/control value
[apiInstance decrementAudioUnitExternamPortInputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    cONTROLCREMENT:cONTROLCREMENT
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor EXTERNAL_PORT_INPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var opts = {
  'cONTROLCREMENT': {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} // {CONTROLCREMENT} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.decrementAudioUnitExternamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class decrementAudioUnitExternamPortInputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var cONTROLCREMENT = new CONTROLCREMENT(); // CONTROLCREMENT |  (optional) 

            try {
                // Decrement audioUnit/externalPortInput/control value
                CONTROL result = apiInstance.decrementAudioUnitExternamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.decrementAudioUnitExternamPortInputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 

try {
    $result = $api_instance->decrementAudioUnitExternamPortInputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $cONTROLCREMENT);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->decrementAudioUnitExternamPortInputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor EXTERNAL_PORT_INPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $cONTROLCREMENT = WWW::OPenAPIClient::Object::CONTROLCREMENT->new(); # CONTROLCREMENT | 

eval { 
    my $result = $api_instance->decrementAudioUnitExternamPortInputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, cONTROLCREMENT => $cONTROLCREMENT);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->decrementAudioUnitExternamPortInputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} # CONTROLCREMENT |  (optional)

try: 
    # Decrement audioUnit/externalPortInput/control value
    api_response = api_instance.decrement_audio_unit_externam_port_input_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT=cONTROLCREMENT)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->decrementAudioUnitExternamPortInputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT

    let mut context = AudioUnitApi::Context::default();
    let result = client.decrementAudioUnitExternamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor EXTERNAL_PORT_INPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Body parameters
Name Description
cONTROLCREMENT

Set Object Name and Control Value

Responses


decrementAudioUnitExternamPortOutputControl

Decrement audioUnit/externalPortOutput/control value

The following objects can be changed and trigger AEM Command on the device. *decrement* The **DECREMENT_CONTROL** command is used to decrement the specified values of a Control by the Control’s step sizes. The decrement_control command acts on a CONTROL descriptor in the current Configuration. An Entity may propagate the value change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. Note that the value only determines the index of control value, which is decremented. In response you will receive the current value, which is determined by the controlValueType. The maximum possible index is the value count described in the descriptor. option you can set the format but also have to specify the value count. The count parameter may only be used with the format parameter. Use this if the entity does not describe it with a descriptor. The values may not be displayed correctly.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortOutput/{stream_idx}/control/{control_index}/decrement

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortOutput/{stream_idx}/control/{control_index}/decrement"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.decrementAudioUnitExternamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#decrementAudioUnitExternamPortOutputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.decrementAudioUnitExternamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#decrementAudioUnitExternamPortOutputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
CONTROLCREMENT *cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; //  (optional)

// Decrement audioUnit/externalPortOutput/control value
[apiInstance decrementAudioUnitExternamPortOutputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    cONTROLCREMENT:cONTROLCREMENT
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor EXTERNAL_PORT_OUTPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var opts = {
  'cONTROLCREMENT': {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} // {CONTROLCREMENT} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.decrementAudioUnitExternamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class decrementAudioUnitExternamPortOutputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var cONTROLCREMENT = new CONTROLCREMENT(); // CONTROLCREMENT |  (optional) 

            try {
                // Decrement audioUnit/externalPortOutput/control value
                CONTROL result = apiInstance.decrementAudioUnitExternamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.decrementAudioUnitExternamPortOutputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 

try {
    $result = $api_instance->decrementAudioUnitExternamPortOutputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $cONTROLCREMENT);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->decrementAudioUnitExternamPortOutputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor EXTERNAL_PORT_OUTPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $cONTROLCREMENT = WWW::OPenAPIClient::Object::CONTROLCREMENT->new(); # CONTROLCREMENT | 

eval { 
    my $result = $api_instance->decrementAudioUnitExternamPortOutputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, cONTROLCREMENT => $cONTROLCREMENT);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->decrementAudioUnitExternamPortOutputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} # CONTROLCREMENT |  (optional)

try: 
    # Decrement audioUnit/externalPortOutput/control value
    api_response = api_instance.decrement_audio_unit_externam_port_output_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT=cONTROLCREMENT)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->decrementAudioUnitExternamPortOutputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT

    let mut context = AudioUnitApi::Context::default();
    let result = client.decrementAudioUnitExternamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor EXTERNAL_PORT_OUTPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Body parameters
Name Description
cONTROLCREMENT

Set Object Name and Control Value

Responses


decrementAudioUnitInternalPortInputControl

Decrement audioUnit/internalPortInput/control value

The following objects can be changed and trigger AEM Command on the device. *decrement* The **DECREMENT_CONTROL** command is used to decrement the specified values of a Control by the Control’s step sizes. The decrement_control command acts on a CONTROL descriptor in the current Configuration. An Entity may propagate the value change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. Note that the value only determines the index of control value, which is decremented. In response you will receive the current value, which is determined by the controlValueType. The maximum possible index is the value count described in the descriptor. option you can set the format but also have to specify the value count. The count parameter may only be used with the format parameter. Use this if the entity does not describe it with a descriptor. The values may not be displayed correctly.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortInput/{stream_idx}/control/{control_index}/decrement

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortInput/{stream_idx}/control/{control_index}/decrement"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.decrementAudioUnitInternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#decrementAudioUnitInternalPortInputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.decrementAudioUnitInternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#decrementAudioUnitInternalPortInputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor INTERNAL_PORT_INPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
CONTROLCREMENT *cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; //  (optional)

// Decrement audioUnit/internalPortInput/control value
[apiInstance decrementAudioUnitInternalPortInputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    cONTROLCREMENT:cONTROLCREMENT
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor INTERNAL_PORT_INPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var opts = {
  'cONTROLCREMENT': {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} // {CONTROLCREMENT} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.decrementAudioUnitInternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class decrementAudioUnitInternalPortInputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor INTERNAL_PORT_INPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var cONTROLCREMENT = new CONTROLCREMENT(); // CONTROLCREMENT |  (optional) 

            try {
                // Decrement audioUnit/internalPortInput/control value
                CONTROL result = apiInstance.decrementAudioUnitInternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.decrementAudioUnitInternalPortInputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 

try {
    $result = $api_instance->decrementAudioUnitInternalPortInputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $cONTROLCREMENT);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->decrementAudioUnitInternalPortInputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor INTERNAL_PORT_INPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $cONTROLCREMENT = WWW::OPenAPIClient::Object::CONTROLCREMENT->new(); # CONTROLCREMENT | 

eval { 
    my $result = $api_instance->decrementAudioUnitInternalPortInputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, cONTROLCREMENT => $cONTROLCREMENT);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->decrementAudioUnitInternalPortInputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor INTERNAL_PORT_INPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} # CONTROLCREMENT |  (optional)

try: 
    # Decrement audioUnit/internalPortInput/control value
    api_response = api_instance.decrement_audio_unit_internal_port_input_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT=cONTROLCREMENT)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->decrementAudioUnitInternalPortInputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT

    let mut context = AudioUnitApi::Context::default();
    let result = client.decrementAudioUnitInternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor INTERNAL_PORT_INPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Body parameters
Name Description
cONTROLCREMENT

Set Object Name and Control Value

Responses


decrementAudioUnitInternalPortOutputControl

Descrement audioUnit/internalPortOutput/control value

The following objects can be changed and trigger AEM Command on the device. *decrement* The **DECREMENT_CONTROL** command is used to decrement the specified values of a Control by the Control’s step sizes. The decrement_control command acts on a CONTROL descriptor in the current Configuration. An Entity may propagate the value change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. Note that the value only determines the index of control value, which is decremented. In response you will receive the current value, which is determined by the controlValueType. The maximum possible index is the value count described in the descriptor. option you can set the format but also have to specify the value count. The count parameter may only be used with the format parameter. Use this if the entity does not describe it with a descriptor. The values may not be displayed correctly.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortOutput/{stream_idx}/control/{control_index}/decrement

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortOutput/{stream_idx}/control/{control_index}/decrement"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.decrementAudioUnitInternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#decrementAudioUnitInternalPortOutputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.decrementAudioUnitInternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#decrementAudioUnitInternalPortOutputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
CONTROLCREMENT *cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; //  (optional)

// Descrement audioUnit/internalPortOutput/control value
[apiInstance decrementAudioUnitInternalPortOutputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    cONTROLCREMENT:cONTROLCREMENT
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor INTERNAL_PORT_OUTPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var opts = {
  'cONTROLCREMENT': {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} // {CONTROLCREMENT} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.decrementAudioUnitInternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class decrementAudioUnitInternalPortOutputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var cONTROLCREMENT = new CONTROLCREMENT(); // CONTROLCREMENT |  (optional) 

            try {
                // Descrement audioUnit/internalPortOutput/control value
                CONTROL result = apiInstance.decrementAudioUnitInternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.decrementAudioUnitInternalPortOutputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 

try {
    $result = $api_instance->decrementAudioUnitInternalPortOutputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $cONTROLCREMENT);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->decrementAudioUnitInternalPortOutputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor INTERNAL_PORT_OUTPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $cONTROLCREMENT = WWW::OPenAPIClient::Object::CONTROLCREMENT->new(); # CONTROLCREMENT | 

eval { 
    my $result = $api_instance->decrementAudioUnitInternalPortOutputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, cONTROLCREMENT => $cONTROLCREMENT);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->decrementAudioUnitInternalPortOutputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} # CONTROLCREMENT |  (optional)

try: 
    # Descrement audioUnit/internalPortOutput/control value
    api_response = api_instance.decrement_audio_unit_internal_port_output_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT=cONTROLCREMENT)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->decrementAudioUnitInternalPortOutputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT

    let mut context = AudioUnitApi::Context::default();
    let result = client.decrementAudioUnitInternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor INTERNAL_PORT_OUTPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Body parameters
Name Description
cONTROLCREMENT

Set Object Name and Control Value

Responses


decrementAudioUnitStreamPortInputControl

Descrement audioUnit/streamPortInput/control value

The following objects can be changed and trigger AEM Command on the device. *decrement* The **DECREMENT_CONTROL** command is used to decrement the specified values of a Control by the Control’s step sizes. The decrement_control command acts on a CONTROL descriptor in the current Configuration. An Entity may propagate the value change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. Note that the value only determines the index of control value, which is decremented. In response you will receive the current value, which is determined by the controlValueType. The maximum possible index is the value count described in the descriptor. option you can set the format but also have to specify the value count. The count parameter may only be used with the format parameter. Use this if the entity does not describe it with a descriptor. The values may not be displayed correctly.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortInput/{stream_idx}/control/{control_index}/decrement

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortInput/{stream_idx}/control/{control_index}/decrement"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.decrementAudioUnitStreamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#decrementAudioUnitStreamPortInputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.decrementAudioUnitStreamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#decrementAudioUnitStreamPortInputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor STREAM_PORT_INPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
CONTROLCREMENT *cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; //  (optional)

// Descrement audioUnit/streamPortInput/control value
[apiInstance decrementAudioUnitStreamPortInputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    cONTROLCREMENT:cONTROLCREMENT
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor STREAM_PORT_INPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var opts = {
  'cONTROLCREMENT': {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} // {CONTROLCREMENT} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.decrementAudioUnitStreamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class decrementAudioUnitStreamPortInputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor STREAM_PORT_INPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var cONTROLCREMENT = new CONTROLCREMENT(); // CONTROLCREMENT |  (optional) 

            try {
                // Descrement audioUnit/streamPortInput/control value
                CONTROL result = apiInstance.decrementAudioUnitStreamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.decrementAudioUnitStreamPortInputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 

try {
    $result = $api_instance->decrementAudioUnitStreamPortInputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $cONTROLCREMENT);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->decrementAudioUnitStreamPortInputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor STREAM_PORT_INPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $cONTROLCREMENT = WWW::OPenAPIClient::Object::CONTROLCREMENT->new(); # CONTROLCREMENT | 

eval { 
    my $result = $api_instance->decrementAudioUnitStreamPortInputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, cONTROLCREMENT => $cONTROLCREMENT);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->decrementAudioUnitStreamPortInputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor STREAM_PORT_INPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} # CONTROLCREMENT |  (optional)

try: 
    # Descrement audioUnit/streamPortInput/control value
    api_response = api_instance.decrement_audio_unit_stream_port_input_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT=cONTROLCREMENT)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->decrementAudioUnitStreamPortInputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT

    let mut context = AudioUnitApi::Context::default();
    let result = client.decrementAudioUnitStreamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor STREAM_PORT_INPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Body parameters
Name Description
cONTROLCREMENT

Set Object Name and Control Value

Responses


decrementAudioUnitStreamPortOutputControl

decrement Descriptor audioUnit/streamPortOutput/control value

The following objects can be changed and trigger AEM Command on the device. *decrement* The **DECREMENT_CONTROL** command is used to decrement the specified values of a Control by the Control’s step sizes. The decrement_control command acts on a CONTROL descriptor in the current Configuration. An Entity may propagate the value change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. Note that the value only determines the index of control value, which is decremented. In response you will receive the current value, which is determined by the controlValueType. The maximum possible index is the value count described in the descriptor. option you can set the format but also have to specify the value count. The count parameter may only be used with the format parameter. Use this if the entity does not describe it with a descriptor. The values may not be displayed correctly.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortOutput/{stream_idx}/control/{control_index}/decrement

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortOutput/{stream_idx}/control/{control_index}/decrement"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.decrementAudioUnitStreamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#decrementAudioUnitStreamPortOutputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.decrementAudioUnitStreamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#decrementAudioUnitStreamPortOutputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor STREAM_PORT_OUTPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
CONTROLCREMENT *cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; //  (optional)

// decrement Descriptor audioUnit/streamPortOutput/control value
[apiInstance decrementAudioUnitStreamPortOutputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    cONTROLCREMENT:cONTROLCREMENT
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor STREAM_PORT_OUTPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var opts = {
  'cONTROLCREMENT': {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} // {CONTROLCREMENT} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.decrementAudioUnitStreamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class decrementAudioUnitStreamPortOutputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor STREAM_PORT_OUTPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var cONTROLCREMENT = new CONTROLCREMENT(); // CONTROLCREMENT |  (optional) 

            try {
                // decrement Descriptor audioUnit/streamPortOutput/control value
                CONTROL result = apiInstance.decrementAudioUnitStreamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.decrementAudioUnitStreamPortOutputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 

try {
    $result = $api_instance->decrementAudioUnitStreamPortOutputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $cONTROLCREMENT);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->decrementAudioUnitStreamPortOutputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor STREAM_PORT_OUTPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $cONTROLCREMENT = WWW::OPenAPIClient::Object::CONTROLCREMENT->new(); # CONTROLCREMENT | 

eval { 
    my $result = $api_instance->decrementAudioUnitStreamPortOutputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, cONTROLCREMENT => $cONTROLCREMENT);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->decrementAudioUnitStreamPortOutputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor STREAM_PORT_OUTPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} # CONTROLCREMENT |  (optional)

try: 
    # decrement Descriptor audioUnit/streamPortOutput/control value
    api_response = api_instance.decrement_audio_unit_stream_port_output_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT=cONTROLCREMENT)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->decrementAudioUnitStreamPortOutputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT

    let mut context = AudioUnitApi::Context::default();
    let result = client.decrementAudioUnitStreamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor STREAM_PORT_OUTPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Body parameters
Name Description
cONTROLCREMENT

Set Object Name and Control Value

Responses


getDescAudioUnit

Get Descriptors from audioUnit


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{unit_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{unit_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer unitIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*currentSampleRate* The **GET_SAMPLING_RATE** command is used to get the current sampling rate of a Port or Unit. 
The get_sampling_rate command returns the sampling rate for the currently active Configuration.

        
        try {
            AUDIO_UNIT result = apiInstance.getDescAudioUnit(deviceId, cfgIdx, unitIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnit");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer unitIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*currentSampleRate* The **GET_SAMPLING_RATE** command is used to get the current sampling rate of a Port or Unit. 
The get_sampling_rate command returns the sampling rate for the currently active Configuration.

        
        try {
            AUDIO_UNIT result = apiInstance.getDescAudioUnit(deviceId, cfgIdx, unitIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnit");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *unitIdx = 0; // Valid top level descriptor index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*currentSampleRate* The **GET_SAMPLING_RATE** command is used to get the current sampling rate of a Port or Unit. 
The get_sampling_rate command returns the sampling rate for the currently active Configuration.
 (optional) (default to null)

// Get Descriptors from audioUnit
[apiInstance getDescAudioUnitWith:deviceId
    cfgIdx:cfgIdx
    unitIdx:unitIdx
    entity:entity
              completionHandler: ^(AUDIO_UNIT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var unitIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*currentSampleRate* The **GET_SAMPLING_RATE** command is used to get the current sampling rate of a Port or Unit. 
The get_sampling_rate command returns the sampling rate for the currently active Configuration.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescAudioUnit(deviceId, cfgIdx, unitIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescAudioUnitExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var unitIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*currentSampleRate* The **GET_SAMPLING_RATE** command is used to get the current sampling rate of a Port or Unit. 
The get_sampling_rate command returns the sampling rate for the currently active Configuration.
 (optional)  (default to null)

            try {
                // Get Descriptors from audioUnit
                AUDIO_UNIT result = apiInstance.getDescAudioUnit(deviceId, cfgIdx, unitIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.getDescAudioUnit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$unitIdx = 0; // Integer | Valid top level descriptor index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*currentSampleRate* The **GET_SAMPLING_RATE** command is used to get the current sampling rate of a Port or Unit. 
The get_sampling_rate command returns the sampling rate for the currently active Configuration.


try {
    $result = $api_instance->getDescAudioUnit($deviceId, $cfgIdx, $unitIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->getDescAudioUnit: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $unitIdx = 0; # Integer | Valid top level descriptor index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*currentSampleRate* The **GET_SAMPLING_RATE** command is used to get the current sampling rate of a Port or Unit. 
The get_sampling_rate command returns the sampling rate for the currently active Configuration.


eval { 
    my $result = $api_instance->getDescAudioUnit(deviceId => $deviceId, cfgIdx => $cfgIdx, unitIdx => $unitIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->getDescAudioUnit: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
unitIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*currentSampleRate* The **GET_SAMPLING_RATE** command is used to get the current sampling rate of a Port or Unit. 
The get_sampling_rate command returns the sampling rate for the currently active Configuration.
 (optional) (default to null)

try: 
    # Get Descriptors from audioUnit
    api_response = api_instance.get_desc_audio_unit(deviceId, cfgIdx, unitIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->getDescAudioUnit: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let unitIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = AudioUnitApi::Context::default();
    let result = client.getDescAudioUnit(deviceId, cfgIdx, unitIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
unit_idx*
Integer
Valid top level descriptor index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on. *currentSampleRate* The **GET_SAMPLING_RATE** command is used to get the current sampling rate of a Port or Unit. The get_sampling_rate command returns the sampling rate for the currently active Configuration.

Responses


getDescAudioUnitExternalPortInput

Get Descriptor audioUnit/externalPortInput


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortInput/{stream_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortInput/{stream_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            EXTERNAL_PORT_INPUT result = apiInstance.getDescAudioUnitExternalPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitExternalPortInput");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            EXTERNAL_PORT_INPUT result = apiInstance.getDescAudioUnitExternalPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitExternalPortInput");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

// Get Descriptor audioUnit/externalPortInput
[apiInstance getDescAudioUnitExternalPortInputWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    entity:entity
              completionHandler: ^(EXTERNAL_PORT_INPUT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor EXTERNAL_PORT_INPUT index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescAudioUnitExternalPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescAudioUnitExternalPortInputExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional)  (default to null)

            try {
                // Get Descriptor audioUnit/externalPortInput
                EXTERNAL_PORT_INPUT result = apiInstance.getDescAudioUnitExternalPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.getDescAudioUnitExternalPortInput: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


try {
    $result = $api_instance->getDescAudioUnitExternalPortInput($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->getDescAudioUnitExternalPortInput: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor EXTERNAL_PORT_INPUT index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


eval { 
    my $result = $api_instance->getDescAudioUnitExternalPortInput(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->getDescAudioUnitExternalPortInput: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

try: 
    # Get Descriptor audioUnit/externalPortInput
    api_response = api_instance.get_desc_audio_unit_external_port_input(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->getDescAudioUnitExternalPortInput: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = AudioUnitApi::Context::default();
    let result = client.getDescAudioUnitExternalPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor EXTERNAL_PORT_INPUT index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database

Responses


getDescAudioUnitExternalPortInputAudioCluster

Get Descriptor audioUnit/externalPortInput/audioCluster


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortInput/{stream_idx}/audioCluster/{cluster_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortInput/{stream_idx}/audioCluster/{cluster_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

        Integer clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            AUDIO_CLUSTER result = apiInstance.getDescAudioUnitExternalPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitExternalPortInputAudioCluster");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

        Integer clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            AUDIO_CLUSTER result = apiInstance.getDescAudioUnitExternalPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitExternalPortInputAudioCluster");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
Integer *clusterIdx = 0; // Descriptor AUDIO_CLUSTER index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

// Get Descriptor audioUnit/externalPortInput/audioCluster
[apiInstance getDescAudioUnitExternalPortInputAudioClusterWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    clusterIdx:clusterIdx
    entity:entity
              completionHandler: ^(AUDIO_CLUSTER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor EXTERNAL_PORT_INPUT index

var clusterIdx = 0; // {Integer} Descriptor AUDIO_CLUSTER index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescAudioUnitExternalPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescAudioUnitExternalPortInputAudioClusterExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
            var clusterIdx = 0;  // Integer | Descriptor AUDIO_CLUSTER index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional)  (default to null)

            try {
                // Get Descriptor audioUnit/externalPortInput/audioCluster
                AUDIO_CLUSTER result = apiInstance.getDescAudioUnitExternalPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.getDescAudioUnitExternalPortInputAudioCluster: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

$clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


try {
    $result = $api_instance->getDescAudioUnitExternalPortInputAudioCluster($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $clusterIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->getDescAudioUnitExternalPortInputAudioCluster: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor EXTERNAL_PORT_INPUT index

my $clusterIdx = 0; # Integer | Descriptor AUDIO_CLUSTER index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


eval { 
    my $result = $api_instance->getDescAudioUnitExternalPortInputAudioCluster(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, clusterIdx => $clusterIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->getDescAudioUnitExternalPortInputAudioCluster: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
clusterIdx = 0 # Integer | Descriptor AUDIO_CLUSTER index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

try: 
    # Get Descriptor audioUnit/externalPortInput/audioCluster
    api_response = api_instance.get_desc_audio_unit_external_port_input_audio_cluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->getDescAudioUnitExternalPortInputAudioCluster: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let clusterIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = AudioUnitApi::Context::default();
    let result = client.getDescAudioUnitExternalPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor EXTERNAL_PORT_INPUT index
Required
cluster_idx*
Integer
Descriptor AUDIO_CLUSTER index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database

Responses


getDescAudioUnitExternalPortInputAudioMap

Get Descriptor audioUnit/externalPortInputAudioMap


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortInput/{stream_idx}/audioMap/{map_index}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortInput/{stream_idx}/audioMap/{map_index}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

        Integer mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            AUDIO_MAP result = apiInstance.getDescAudioUnitExternalPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitExternalPortInputAudioMap");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

        Integer mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            AUDIO_MAP result = apiInstance.getDescAudioUnitExternalPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitExternalPortInputAudioMap");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
Integer *mapIndex = 0; // Descriptor AUDIO_MAP index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

// Get Descriptor audioUnit/externalPortInputAudioMap
[apiInstance getDescAudioUnitExternalPortInputAudioMapWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    mapIndex:mapIndex
    entity:entity
              completionHandler: ^(AUDIO_MAP output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor EXTERNAL_PORT_INPUT index

var mapIndex = 0; // {Integer} Descriptor AUDIO_MAP index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescAudioUnitExternalPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescAudioUnitExternalPortInputAudioMapExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
            var mapIndex = 0;  // Integer | Descriptor AUDIO_MAP index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional)  (default to null)

            try {
                // Get Descriptor audioUnit/externalPortInputAudioMap
                AUDIO_MAP result = apiInstance.getDescAudioUnitExternalPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.getDescAudioUnitExternalPortInputAudioMap: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

$mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


try {
    $result = $api_instance->getDescAudioUnitExternalPortInputAudioMap($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $mapIndex, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->getDescAudioUnitExternalPortInputAudioMap: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor EXTERNAL_PORT_INPUT index

my $mapIndex = 0; # Integer | Descriptor AUDIO_MAP index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


eval { 
    my $result = $api_instance->getDescAudioUnitExternalPortInputAudioMap(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, mapIndex => $mapIndex, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->getDescAudioUnitExternalPortInputAudioMap: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
mapIndex = 0 # Integer | Descriptor AUDIO_MAP index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

try: 
    # Get Descriptor audioUnit/externalPortInputAudioMap
    api_response = api_instance.get_desc_audio_unit_external_port_input_audio_map(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->getDescAudioUnitExternalPortInputAudioMap: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let mapIndex = 0; // Integer
    let entity = ; // array[String]

    let mut context = AudioUnitApi::Context::default();
    let result = client.getDescAudioUnitExternalPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor EXTERNAL_PORT_INPUT index
Required
map_index*
Integer
Descriptor AUDIO_MAP index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database

Responses


getDescAudioUnitExternalPortInputControl

Get Descriptor audioUnit/externalPortInput/control


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortInput/{stream_idx}/control/{control_index}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortInput/{stream_idx}/control/{control_index}?entity=&format="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

        Format2 format = ; // Format2 | specific value Control Value 

        
        try {
            CONTROL result = apiInstance.getDescAudioUnitExternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitExternalPortInputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

        Format2 format = ; // Format2 | specific value Control Value 

        
        try {
            CONTROL result = apiInstance.getDescAudioUnitExternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitExternalPortInputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
 (optional) (default to null)
Format2 *format = ; // specific value Control Value 
 (optional) (default to null)

// Get Descriptor audioUnit/externalPortInput/control
[apiInstance getDescAudioUnitExternalPortInputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    entity:entity
    format:format
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor EXTERNAL_PORT_INPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var opts = {
  'entity': , // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

  'format':  // {Format2} specific value Control Value 

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescAudioUnitExternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescAudioUnitExternalPortInputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
 (optional)  (default to null)
            var format = new Format2(); // Format2 | specific value Control Value 
 (optional)  (default to null)

            try {
                // Get Descriptor audioUnit/externalPortInput/control
                CONTROL result = apiInstance.getDescAudioUnitExternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.getDescAudioUnitExternalPortInputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

$format = ; // Format2 | specific value Control Value 


try {
    $result = $api_instance->getDescAudioUnitExternalPortInputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $entity, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->getDescAudioUnitExternalPortInputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor EXTERNAL_PORT_INPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

my $format = ; # Format2 | specific value Control Value 


eval { 
    my $result = $api_instance->getDescAudioUnitExternalPortInputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, entity => $entity, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->getDescAudioUnitExternalPortInputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
 (optional) (default to null)
format =  # Format2 | specific value Control Value 
 (optional) (default to null)

try: 
    # Get Descriptor audioUnit/externalPortInput/control
    api_response = api_instance.get_desc_audio_unit_external_port_input_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity=entity, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->getDescAudioUnitExternalPortInputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let entity = ; // array[String]
    let format = ; // Format2

    let mut context = AudioUnitApi::Context::default();
    let result = client.getDescAudioUnitExternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity, format, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor EXTERNAL_PORT_INPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *value* The **GET_CONTROL** command is used to get the current values of a Control. The get_control command returns the value for the currently active Configuration. The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
format
Format2
specific value Control Value

Responses


getDescAudioUnitExternalPortOutput

Get Descriptor audioUnit/externalPortOutput


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortOutput/{stream_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortOutput/{stream_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            EXTERNAL_PORT_OUTPUT result = apiInstance.getDescAudioUnitExternalPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitExternalPortOutput");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            EXTERNAL_PORT_OUTPUT result = apiInstance.getDescAudioUnitExternalPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitExternalPortOutput");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

// Get Descriptor audioUnit/externalPortOutput
[apiInstance getDescAudioUnitExternalPortOutputWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    entity:entity
              completionHandler: ^(EXTERNAL_PORT_OUTPUT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor EXTERNAL_PORT_OUTPUT index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescAudioUnitExternalPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescAudioUnitExternalPortOutputExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional)  (default to null)

            try {
                // Get Descriptor audioUnit/externalPortOutput
                EXTERNAL_PORT_OUTPUT result = apiInstance.getDescAudioUnitExternalPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.getDescAudioUnitExternalPortOutput: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


try {
    $result = $api_instance->getDescAudioUnitExternalPortOutput($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->getDescAudioUnitExternalPortOutput: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor EXTERNAL_PORT_OUTPUT index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


eval { 
    my $result = $api_instance->getDescAudioUnitExternalPortOutput(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->getDescAudioUnitExternalPortOutput: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

try: 
    # Get Descriptor audioUnit/externalPortOutput
    api_response = api_instance.get_desc_audio_unit_external_port_output(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->getDescAudioUnitExternalPortOutput: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = AudioUnitApi::Context::default();
    let result = client.getDescAudioUnitExternalPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor EXTERNAL_PORT_OUTPUT index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database

Responses


getDescAudioUnitExternalPortOutputAudioCluster

Get Descriptor audioUnit/externalPortOutput/audioCluster


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortOutput/{stream_idx}/audioCluster/{cluster_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortOutput/{stream_idx}/audioCluster/{cluster_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

        Integer clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            AUDIO_CLUSTER result = apiInstance.getDescAudioUnitExternalPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitExternalPortOutputAudioCluster");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

        Integer clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            AUDIO_CLUSTER result = apiInstance.getDescAudioUnitExternalPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitExternalPortOutputAudioCluster");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
Integer *clusterIdx = 0; // Descriptor AUDIO_CLUSTER index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

// Get Descriptor audioUnit/externalPortOutput/audioCluster
[apiInstance getDescAudioUnitExternalPortOutputAudioClusterWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    clusterIdx:clusterIdx
    entity:entity
              completionHandler: ^(AUDIO_CLUSTER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor EXTERNAL_PORT_OUTPUT index

var clusterIdx = 0; // {Integer} Descriptor AUDIO_CLUSTER index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescAudioUnitExternalPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescAudioUnitExternalPortOutputAudioClusterExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
            var clusterIdx = 0;  // Integer | Descriptor AUDIO_CLUSTER index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional)  (default to null)

            try {
                // Get Descriptor audioUnit/externalPortOutput/audioCluster
                AUDIO_CLUSTER result = apiInstance.getDescAudioUnitExternalPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.getDescAudioUnitExternalPortOutputAudioCluster: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

$clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


try {
    $result = $api_instance->getDescAudioUnitExternalPortOutputAudioCluster($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $clusterIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->getDescAudioUnitExternalPortOutputAudioCluster: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor EXTERNAL_PORT_OUTPUT index

my $clusterIdx = 0; # Integer | Descriptor AUDIO_CLUSTER index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


eval { 
    my $result = $api_instance->getDescAudioUnitExternalPortOutputAudioCluster(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, clusterIdx => $clusterIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->getDescAudioUnitExternalPortOutputAudioCluster: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
clusterIdx = 0 # Integer | Descriptor AUDIO_CLUSTER index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

try: 
    # Get Descriptor audioUnit/externalPortOutput/audioCluster
    api_response = api_instance.get_desc_audio_unit_external_port_output_audio_cluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->getDescAudioUnitExternalPortOutputAudioCluster: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let clusterIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = AudioUnitApi::Context::default();
    let result = client.getDescAudioUnitExternalPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor EXTERNAL_PORT_OUTPUT index
Required
cluster_idx*
Integer
Descriptor AUDIO_CLUSTER index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database

Responses


getDescAudioUnitExternalPortOutputAudioMap

Get Descriptor audioUnit/externalPortOutput/audioMap


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortOutput/{stream_idx}/audioMap/{map_index}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortOutput/{stream_idx}/audioMap/{map_index}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

        Integer mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            AUDIO_MAP result = apiInstance.getDescAudioUnitExternalPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitExternalPortOutputAudioMap");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

        Integer mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            AUDIO_MAP result = apiInstance.getDescAudioUnitExternalPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitExternalPortOutputAudioMap");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
Integer *mapIndex = 0; // Descriptor AUDIO_MAP index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

// Get Descriptor audioUnit/externalPortOutput/audioMap
[apiInstance getDescAudioUnitExternalPortOutputAudioMapWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    mapIndex:mapIndex
    entity:entity
              completionHandler: ^(AUDIO_MAP output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor EXTERNAL_PORT_OUTPUT index

var mapIndex = 0; // {Integer} Descriptor AUDIO_MAP index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescAudioUnitExternalPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescAudioUnitExternalPortOutputAudioMapExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
            var mapIndex = 0;  // Integer | Descriptor AUDIO_MAP index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional)  (default to null)

            try {
                // Get Descriptor audioUnit/externalPortOutput/audioMap
                AUDIO_MAP result = apiInstance.getDescAudioUnitExternalPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.getDescAudioUnitExternalPortOutputAudioMap: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

$mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


try {
    $result = $api_instance->getDescAudioUnitExternalPortOutputAudioMap($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $mapIndex, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->getDescAudioUnitExternalPortOutputAudioMap: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor EXTERNAL_PORT_OUTPUT index

my $mapIndex = 0; # Integer | Descriptor AUDIO_MAP index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


eval { 
    my $result = $api_instance->getDescAudioUnitExternalPortOutputAudioMap(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, mapIndex => $mapIndex, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->getDescAudioUnitExternalPortOutputAudioMap: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
mapIndex = 0 # Integer | Descriptor AUDIO_MAP index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

try: 
    # Get Descriptor audioUnit/externalPortOutput/audioMap
    api_response = api_instance.get_desc_audio_unit_external_port_output_audio_map(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->getDescAudioUnitExternalPortOutputAudioMap: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let mapIndex = 0; // Integer
    let entity = ; // array[String]

    let mut context = AudioUnitApi::Context::default();
    let result = client.getDescAudioUnitExternalPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor EXTERNAL_PORT_OUTPUT index
Required
map_index*
Integer
Descriptor AUDIO_MAP index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database

Responses


getDescAudioUnitExternalPortOutputControl

Get Descriptor audioUnit/externalPortOutput/control


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortOutput/{stream_idx}/control/{control_index}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortOutput/{stream_idx}/control/{control_index}?entity=&format="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

        Format3 format = ; // Format3 | specific value Control Value 

        
        try {
            CONTROL result = apiInstance.getDescAudioUnitExternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitExternalPortOutputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

        Format3 format = ; // Format3 | specific value Control Value 

        
        try {
            CONTROL result = apiInstance.getDescAudioUnitExternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitExternalPortOutputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
 (optional) (default to null)
Format3 *format = ; // specific value Control Value 
 (optional) (default to null)

// Get Descriptor audioUnit/externalPortOutput/control
[apiInstance getDescAudioUnitExternalPortOutputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    entity:entity
    format:format
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor EXTERNAL_PORT_OUTPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var opts = {
  'entity': , // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

  'format':  // {Format3} specific value Control Value 

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescAudioUnitExternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescAudioUnitExternalPortOutputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
 (optional)  (default to null)
            var format = new Format3(); // Format3 | specific value Control Value 
 (optional)  (default to null)

            try {
                // Get Descriptor audioUnit/externalPortOutput/control
                CONTROL result = apiInstance.getDescAudioUnitExternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.getDescAudioUnitExternalPortOutputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

$format = ; // Format3 | specific value Control Value 


try {
    $result = $api_instance->getDescAudioUnitExternalPortOutputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $entity, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->getDescAudioUnitExternalPortOutputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor EXTERNAL_PORT_OUTPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

my $format = ; # Format3 | specific value Control Value 


eval { 
    my $result = $api_instance->getDescAudioUnitExternalPortOutputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, entity => $entity, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->getDescAudioUnitExternalPortOutputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
 (optional) (default to null)
format =  # Format3 | specific value Control Value 
 (optional) (default to null)

try: 
    # Get Descriptor audioUnit/externalPortOutput/control
    api_response = api_instance.get_desc_audio_unit_external_port_output_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity=entity, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->getDescAudioUnitExternalPortOutputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let entity = ; // array[String]
    let format = ; // Format3

    let mut context = AudioUnitApi::Context::default();
    let result = client.getDescAudioUnitExternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity, format, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor EXTERNAL_PORT_OUTPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *value* The **GET_CONTROL** command is used to get the current values of a Control. The get_control command returns the value for the currently active Configuration. The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
format
Format3
specific value Control Value

Responses


getDescAudioUnitInternalPortInput

Get Descriptor audioUnit/internalPortInput


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortInput/{stream_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortInput/{stream_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            INTERNAL_PORT_INPUT result = apiInstance.getDescAudioUnitInternalPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitInternalPortInput");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            INTERNAL_PORT_INPUT result = apiInstance.getDescAudioUnitInternalPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitInternalPortInput");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor INTERNAL_PORT_INPUT index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

// Get Descriptor audioUnit/internalPortInput
[apiInstance getDescAudioUnitInternalPortInputWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    entity:entity
              completionHandler: ^(INTERNAL_PORT_INPUT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor INTERNAL_PORT_INPUT index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescAudioUnitInternalPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescAudioUnitInternalPortInputExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor INTERNAL_PORT_INPUT index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional)  (default to null)

            try {
                // Get Descriptor audioUnit/internalPortInput
                INTERNAL_PORT_INPUT result = apiInstance.getDescAudioUnitInternalPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.getDescAudioUnitInternalPortInput: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


try {
    $result = $api_instance->getDescAudioUnitInternalPortInput($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->getDescAudioUnitInternalPortInput: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor INTERNAL_PORT_INPUT index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


eval { 
    my $result = $api_instance->getDescAudioUnitInternalPortInput(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->getDescAudioUnitInternalPortInput: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor INTERNAL_PORT_INPUT index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

try: 
    # Get Descriptor audioUnit/internalPortInput
    api_response = api_instance.get_desc_audio_unit_internal_port_input(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->getDescAudioUnitInternalPortInput: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = AudioUnitApi::Context::default();
    let result = client.getDescAudioUnitInternalPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor INTERNAL_PORT_INPUT index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database

Responses


getDescAudioUnitInternalPortInputAudioCluster

Get Descriptor audioUnit/internalPortInput/audioCluster


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortInput/{stream_idx}/audioCluster/{cluster_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortInput/{stream_idx}/audioCluster/{cluster_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

        Integer clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            AUDIO_CLUSTER result = apiInstance.getDescAudioUnitInternalPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitInternalPortInputAudioCluster");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

        Integer clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            AUDIO_CLUSTER result = apiInstance.getDescAudioUnitInternalPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitInternalPortInputAudioCluster");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor INTERNAL_PORT_INPUT index
 (default to null)
Integer *clusterIdx = 0; // Descriptor AUDIO_CLUSTER index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

// Get Descriptor audioUnit/internalPortInput/audioCluster
[apiInstance getDescAudioUnitInternalPortInputAudioClusterWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    clusterIdx:clusterIdx
    entity:entity
              completionHandler: ^(AUDIO_CLUSTER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor INTERNAL_PORT_INPUT index

var clusterIdx = 0; // {Integer} Descriptor AUDIO_CLUSTER index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescAudioUnitInternalPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescAudioUnitInternalPortInputAudioClusterExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor INTERNAL_PORT_INPUT index
 (default to null)
            var clusterIdx = 0;  // Integer | Descriptor AUDIO_CLUSTER index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional)  (default to null)

            try {
                // Get Descriptor audioUnit/internalPortInput/audioCluster
                AUDIO_CLUSTER result = apiInstance.getDescAudioUnitInternalPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.getDescAudioUnitInternalPortInputAudioCluster: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

$clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


try {
    $result = $api_instance->getDescAudioUnitInternalPortInputAudioCluster($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $clusterIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->getDescAudioUnitInternalPortInputAudioCluster: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor INTERNAL_PORT_INPUT index

my $clusterIdx = 0; # Integer | Descriptor AUDIO_CLUSTER index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


eval { 
    my $result = $api_instance->getDescAudioUnitInternalPortInputAudioCluster(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, clusterIdx => $clusterIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->getDescAudioUnitInternalPortInputAudioCluster: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor INTERNAL_PORT_INPUT index
 (default to null)
clusterIdx = 0 # Integer | Descriptor AUDIO_CLUSTER index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

try: 
    # Get Descriptor audioUnit/internalPortInput/audioCluster
    api_response = api_instance.get_desc_audio_unit_internal_port_input_audio_cluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->getDescAudioUnitInternalPortInputAudioCluster: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let clusterIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = AudioUnitApi::Context::default();
    let result = client.getDescAudioUnitInternalPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor INTERNAL_PORT_INPUT index
Required
cluster_idx*
Integer
Descriptor AUDIO_CLUSTER index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database

Responses


getDescAudioUnitInternalPortInputAudioMap

Get Descriptor audioUnit/internalPortInput/audioMap


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortInput/{stream_idx}/audioMap/{map_index}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortInput/{stream_idx}/audioMap/{map_index}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

        Integer mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            AUDIO_MAP result = apiInstance.getDescAudioUnitInternalPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitInternalPortInputAudioMap");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

        Integer mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            AUDIO_MAP result = apiInstance.getDescAudioUnitInternalPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitInternalPortInputAudioMap");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor INTERNAL_PORT_INPUT index
 (default to null)
Integer *mapIndex = 0; // Descriptor AUDIO_MAP index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

// Get Descriptor audioUnit/internalPortInput/audioMap
[apiInstance getDescAudioUnitInternalPortInputAudioMapWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    mapIndex:mapIndex
    entity:entity
              completionHandler: ^(AUDIO_MAP output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor INTERNAL_PORT_INPUT index

var mapIndex = 0; // {Integer} Descriptor AUDIO_MAP index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescAudioUnitInternalPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescAudioUnitInternalPortInputAudioMapExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor INTERNAL_PORT_INPUT index
 (default to null)
            var mapIndex = 0;  // Integer | Descriptor AUDIO_MAP index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional)  (default to null)

            try {
                // Get Descriptor audioUnit/internalPortInput/audioMap
                AUDIO_MAP result = apiInstance.getDescAudioUnitInternalPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.getDescAudioUnitInternalPortInputAudioMap: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

$mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


try {
    $result = $api_instance->getDescAudioUnitInternalPortInputAudioMap($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $mapIndex, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->getDescAudioUnitInternalPortInputAudioMap: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor INTERNAL_PORT_INPUT index

my $mapIndex = 0; # Integer | Descriptor AUDIO_MAP index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


eval { 
    my $result = $api_instance->getDescAudioUnitInternalPortInputAudioMap(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, mapIndex => $mapIndex, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->getDescAudioUnitInternalPortInputAudioMap: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor INTERNAL_PORT_INPUT index
 (default to null)
mapIndex = 0 # Integer | Descriptor AUDIO_MAP index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

try: 
    # Get Descriptor audioUnit/internalPortInput/audioMap
    api_response = api_instance.get_desc_audio_unit_internal_port_input_audio_map(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->getDescAudioUnitInternalPortInputAudioMap: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let mapIndex = 0; // Integer
    let entity = ; // array[String]

    let mut context = AudioUnitApi::Context::default();
    let result = client.getDescAudioUnitInternalPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor INTERNAL_PORT_INPUT index
Required
map_index*
Integer
Descriptor AUDIO_MAP index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database

Responses


getDescAudioUnitInternalPortInputControl

Get Descriptor audioUnit/internalPortInput/control


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortInput/{stream_idx}/control/{control_index}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortInput/{stream_idx}/control/{control_index}?entity=&format="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

        Format4 format = ; // Format4 | specific value Control Value 

        
        try {
            CONTROL result = apiInstance.getDescAudioUnitInternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitInternalPortInputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

        Format4 format = ; // Format4 | specific value Control Value 

        
        try {
            CONTROL result = apiInstance.getDescAudioUnitInternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitInternalPortInputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor INTERNAL_PORT_INPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
 (optional) (default to null)
Format4 *format = ; // specific value Control Value 
 (optional) (default to null)

// Get Descriptor audioUnit/internalPortInput/control
[apiInstance getDescAudioUnitInternalPortInputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    entity:entity
    format:format
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor INTERNAL_PORT_INPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var opts = {
  'entity': , // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

  'format':  // {Format4} specific value Control Value 

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescAudioUnitInternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescAudioUnitInternalPortInputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor INTERNAL_PORT_INPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
 (optional)  (default to null)
            var format = new Format4(); // Format4 | specific value Control Value 
 (optional)  (default to null)

            try {
                // Get Descriptor audioUnit/internalPortInput/control
                CONTROL result = apiInstance.getDescAudioUnitInternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.getDescAudioUnitInternalPortInputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

$format = ; // Format4 | specific value Control Value 


try {
    $result = $api_instance->getDescAudioUnitInternalPortInputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $entity, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->getDescAudioUnitInternalPortInputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor INTERNAL_PORT_INPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

my $format = ; # Format4 | specific value Control Value 


eval { 
    my $result = $api_instance->getDescAudioUnitInternalPortInputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, entity => $entity, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->getDescAudioUnitInternalPortInputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor INTERNAL_PORT_INPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
 (optional) (default to null)
format =  # Format4 | specific value Control Value 
 (optional) (default to null)

try: 
    # Get Descriptor audioUnit/internalPortInput/control
    api_response = api_instance.get_desc_audio_unit_internal_port_input_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity=entity, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->getDescAudioUnitInternalPortInputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let entity = ; // array[String]
    let format = ; // Format4

    let mut context = AudioUnitApi::Context::default();
    let result = client.getDescAudioUnitInternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity, format, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor INTERNAL_PORT_INPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *value* The **GET_CONTROL** command is used to get the current values of a Control. The get_control command returns the value for the currently active Configuration. The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
format
Format4
specific value Control Value

Responses


getDescAudioUnitInternalPortOutput

Get Descriptor audioUnit/internalPortOutput


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortOutput/{stream_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortOutput/{stream_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            INTERNAL_PORT_OUTPUT result = apiInstance.getDescAudioUnitInternalPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitInternalPortOutput");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            INTERNAL_PORT_OUTPUT result = apiInstance.getDescAudioUnitInternalPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitInternalPortOutput");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

// Get Descriptor audioUnit/internalPortOutput
[apiInstance getDescAudioUnitInternalPortOutputWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    entity:entity
              completionHandler: ^(INTERNAL_PORT_OUTPUT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor INTERNAL_PORT_OUTPUT index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescAudioUnitInternalPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescAudioUnitInternalPortOutputExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional)  (default to null)

            try {
                // Get Descriptor audioUnit/internalPortOutput
                INTERNAL_PORT_OUTPUT result = apiInstance.getDescAudioUnitInternalPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.getDescAudioUnitInternalPortOutput: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


try {
    $result = $api_instance->getDescAudioUnitInternalPortOutput($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->getDescAudioUnitInternalPortOutput: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor INTERNAL_PORT_OUTPUT index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


eval { 
    my $result = $api_instance->getDescAudioUnitInternalPortOutput(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->getDescAudioUnitInternalPortOutput: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

try: 
    # Get Descriptor audioUnit/internalPortOutput
    api_response = api_instance.get_desc_audio_unit_internal_port_output(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->getDescAudioUnitInternalPortOutput: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = AudioUnitApi::Context::default();
    let result = client.getDescAudioUnitInternalPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor INTERNAL_PORT_OUTPUT index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database

Responses


getDescAudioUnitInternalPortOutput/Control

Get Descriptor audioUnit/internalPortOutput/control


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortOutput/{stream_idx}/control/{control_index}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortOutput/{stream_idx}/control/{control_index}?entity=&format="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

        Format5 format = ; // Format5 | specific value Control Value 

        
        try {
            CONTROL result = apiInstance.getDescAudioUnitInternalPortOutput/Control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitInternalPortOutput/Control");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

        Format5 format = ; // Format5 | specific value Control Value 

        
        try {
            CONTROL result = apiInstance.getDescAudioUnitInternalPortOutput/Control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitInternalPortOutput/Control");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
 (optional) (default to null)
Format5 *format = ; // specific value Control Value 
 (optional) (default to null)

// Get Descriptor audioUnit/internalPortOutput/control
[apiInstance getDescAudioUnitInternalPortOutput/ControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    entity:entity
    format:format
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor INTERNAL_PORT_OUTPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var opts = {
  'entity': , // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

  'format':  // {Format5} specific value Control Value 

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescAudioUnitInternalPortOutput/Control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescAudioUnitInternalPortOutput/ControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
 (optional)  (default to null)
            var format = new Format5(); // Format5 | specific value Control Value 
 (optional)  (default to null)

            try {
                // Get Descriptor audioUnit/internalPortOutput/control
                CONTROL result = apiInstance.getDescAudioUnitInternalPortOutput/Control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.getDescAudioUnitInternalPortOutput/Control: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

$format = ; // Format5 | specific value Control Value 


try {
    $result = $api_instance->getDescAudioUnitInternalPortOutput/Control($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $entity, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->getDescAudioUnitInternalPortOutput/Control: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor INTERNAL_PORT_OUTPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

my $format = ; # Format5 | specific value Control Value 


eval { 
    my $result = $api_instance->getDescAudioUnitInternalPortOutput/Control(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, entity => $entity, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->getDescAudioUnitInternalPortOutput/Control: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
 (optional) (default to null)
format =  # Format5 | specific value Control Value 
 (optional) (default to null)

try: 
    # Get Descriptor audioUnit/internalPortOutput/control
    api_response = api_instance.get_desc_audio_unit_internal_port_output/control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity=entity, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->getDescAudioUnitInternalPortOutput/Control: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let entity = ; // array[String]
    let format = ; // Format5

    let mut context = AudioUnitApi::Context::default();
    let result = client.getDescAudioUnitInternalPortOutput/Control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity, format, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor INTERNAL_PORT_OUTPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *value* The **GET_CONTROL** command is used to get the current values of a Control. The get_control command returns the value for the currently active Configuration. The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
format
Format5
specific value Control Value

Responses


getDescAudioUnitInternalPortOutputAudioCluster

Get Descriptor audioUnit/internalPortOutput/audioCluster


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortOutput/{stream_idx}/audioCluster/{cluster_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortOutput/{stream_idx}/audioCluster/{cluster_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

        Integer clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            AUDIO_CLUSTER result = apiInstance.getDescAudioUnitInternalPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitInternalPortOutputAudioCluster");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

        Integer clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            AUDIO_CLUSTER result = apiInstance.getDescAudioUnitInternalPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitInternalPortOutputAudioCluster");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
Integer *clusterIdx = 0; // Descriptor AUDIO_CLUSTER index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

// Get Descriptor audioUnit/internalPortOutput/audioCluster
[apiInstance getDescAudioUnitInternalPortOutputAudioClusterWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    clusterIdx:clusterIdx
    entity:entity
              completionHandler: ^(AUDIO_CLUSTER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor INTERNAL_PORT_OUTPUT index

var clusterIdx = 0; // {Integer} Descriptor AUDIO_CLUSTER index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescAudioUnitInternalPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescAudioUnitInternalPortOutputAudioClusterExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
            var clusterIdx = 0;  // Integer | Descriptor AUDIO_CLUSTER index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional)  (default to null)

            try {
                // Get Descriptor audioUnit/internalPortOutput/audioCluster
                AUDIO_CLUSTER result = apiInstance.getDescAudioUnitInternalPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.getDescAudioUnitInternalPortOutputAudioCluster: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

$clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


try {
    $result = $api_instance->getDescAudioUnitInternalPortOutputAudioCluster($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $clusterIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->getDescAudioUnitInternalPortOutputAudioCluster: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor INTERNAL_PORT_OUTPUT index

my $clusterIdx = 0; # Integer | Descriptor AUDIO_CLUSTER index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


eval { 
    my $result = $api_instance->getDescAudioUnitInternalPortOutputAudioCluster(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, clusterIdx => $clusterIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->getDescAudioUnitInternalPortOutputAudioCluster: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
clusterIdx = 0 # Integer | Descriptor AUDIO_CLUSTER index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

try: 
    # Get Descriptor audioUnit/internalPortOutput/audioCluster
    api_response = api_instance.get_desc_audio_unit_internal_port_output_audio_cluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->getDescAudioUnitInternalPortOutputAudioCluster: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let clusterIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = AudioUnitApi::Context::default();
    let result = client.getDescAudioUnitInternalPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor INTERNAL_PORT_OUTPUT index
Required
cluster_idx*
Integer
Descriptor AUDIO_CLUSTER index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database

Responses


getDescAudioUnitInternalPortOutputAudioMap

Get Descriptor audioUnit/internalPortOutput/audioMap


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/internalPortOutput/{stream_idx}/audioMap/{map_index}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/internalPortOutput/{stream_idx}/audioMap/{map_index}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

        Integer mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            AUDIO_MAP result = apiInstance.getDescAudioUnitInternalPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitInternalPortOutputAudioMap");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

        Integer mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            AUDIO_MAP result = apiInstance.getDescAudioUnitInternalPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitInternalPortOutputAudioMap");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
Integer *mapIndex = 0; // Descriptor AUDIO_MAP index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

// Get Descriptor audioUnit/internalPortOutput/audioMap
[apiInstance getDescAudioUnitInternalPortOutputAudioMapWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    mapIndex:mapIndex
    entity:entity
              completionHandler: ^(AUDIO_MAP output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor INTERNAL_PORT_OUTPUT index

var mapIndex = 0; // {Integer} Descriptor AUDIO_MAP index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescAudioUnitInternalPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescAudioUnitInternalPortOutputAudioMapExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
            var mapIndex = 0;  // Integer | Descriptor AUDIO_MAP index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional)  (default to null)

            try {
                // Get Descriptor audioUnit/internalPortOutput/audioMap
                AUDIO_MAP result = apiInstance.getDescAudioUnitInternalPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.getDescAudioUnitInternalPortOutputAudioMap: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

$mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


try {
    $result = $api_instance->getDescAudioUnitInternalPortOutputAudioMap($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $mapIndex, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->getDescAudioUnitInternalPortOutputAudioMap: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor INTERNAL_PORT_OUTPUT index

my $mapIndex = 0; # Integer | Descriptor AUDIO_MAP index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


eval { 
    my $result = $api_instance->getDescAudioUnitInternalPortOutputAudioMap(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, mapIndex => $mapIndex, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->getDescAudioUnitInternalPortOutputAudioMap: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
mapIndex = 0 # Integer | Descriptor AUDIO_MAP index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

try: 
    # Get Descriptor audioUnit/internalPortOutput/audioMap
    api_response = api_instance.get_desc_audio_unit_internal_port_output_audio_map(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->getDescAudioUnitInternalPortOutputAudioMap: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let mapIndex = 0; // Integer
    let entity = ; // array[String]

    let mut context = AudioUnitApi::Context::default();
    let result = client.getDescAudioUnitInternalPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor INTERNAL_PORT_OUTPUT index
Required
map_index*
Integer
Descriptor AUDIO_MAP index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database

Responses


getDescAudioUnitStreamPortInput

Get Descriptor audioUnit/streamPortInput


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/streamPortInput/{stream_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/streamPortInput/{stream_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            STREAM_PORT_INPUT result = apiInstance.getDescAudioUnitStreamPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitStreamPortInput");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            STREAM_PORT_INPUT result = apiInstance.getDescAudioUnitStreamPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitStreamPortInput");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor STREAM_PORT_INPUT index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

// Get Descriptor audioUnit/streamPortInput
[apiInstance getDescAudioUnitStreamPortInputWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    entity:entity
              completionHandler: ^(STREAM_PORT_INPUT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor STREAM_PORT_INPUT index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescAudioUnitStreamPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescAudioUnitStreamPortInputExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor STREAM_PORT_INPUT index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional)  (default to null)

            try {
                // Get Descriptor audioUnit/streamPortInput
                STREAM_PORT_INPUT result = apiInstance.getDescAudioUnitStreamPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.getDescAudioUnitStreamPortInput: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


try {
    $result = $api_instance->getDescAudioUnitStreamPortInput($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->getDescAudioUnitStreamPortInput: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor STREAM_PORT_INPUT index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


eval { 
    my $result = $api_instance->getDescAudioUnitStreamPortInput(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->getDescAudioUnitStreamPortInput: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor STREAM_PORT_INPUT index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

try: 
    # Get Descriptor audioUnit/streamPortInput
    api_response = api_instance.get_desc_audio_unit_stream_port_input(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->getDescAudioUnitStreamPortInput: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = AudioUnitApi::Context::default();
    let result = client.getDescAudioUnitStreamPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor STREAM_PORT_INPUT index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database

Responses


getDescAudioUnitStreamPortInputAudioCluster

Get Descriptor audioUnit/streamPortInput/audioCluster


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortInput/{stream_idx}/audioCluster/{cluster_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortInput/{stream_idx}/audioCluster/{cluster_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

        Integer clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            AUDIO_CLUSTER result = apiInstance.getDescAudioUnitStreamPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitStreamPortInputAudioCluster");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

        Integer clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            AUDIO_CLUSTER result = apiInstance.getDescAudioUnitStreamPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitStreamPortInputAudioCluster");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor STREAM_PORT_INPUT index
 (default to null)
Integer *clusterIdx = 0; // Descriptor AUDIO_CLUSTER index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

// Get Descriptor audioUnit/streamPortInput/audioCluster
[apiInstance getDescAudioUnitStreamPortInputAudioClusterWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    clusterIdx:clusterIdx
    entity:entity
              completionHandler: ^(AUDIO_CLUSTER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor STREAM_PORT_INPUT index

var clusterIdx = 0; // {Integer} Descriptor AUDIO_CLUSTER index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescAudioUnitStreamPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescAudioUnitStreamPortInputAudioClusterExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor STREAM_PORT_INPUT index
 (default to null)
            var clusterIdx = 0;  // Integer | Descriptor AUDIO_CLUSTER index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional)  (default to null)

            try {
                // Get Descriptor audioUnit/streamPortInput/audioCluster
                AUDIO_CLUSTER result = apiInstance.getDescAudioUnitStreamPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.getDescAudioUnitStreamPortInputAudioCluster: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

$clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


try {
    $result = $api_instance->getDescAudioUnitStreamPortInputAudioCluster($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $clusterIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->getDescAudioUnitStreamPortInputAudioCluster: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor STREAM_PORT_INPUT index

my $clusterIdx = 0; # Integer | Descriptor AUDIO_CLUSTER index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


eval { 
    my $result = $api_instance->getDescAudioUnitStreamPortInputAudioCluster(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, clusterIdx => $clusterIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->getDescAudioUnitStreamPortInputAudioCluster: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor STREAM_PORT_INPUT index
 (default to null)
clusterIdx = 0 # Integer | Descriptor AUDIO_CLUSTER index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

try: 
    # Get Descriptor audioUnit/streamPortInput/audioCluster
    api_response = api_instance.get_desc_audio_unit_stream_port_input_audio_cluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->getDescAudioUnitStreamPortInputAudioCluster: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let clusterIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = AudioUnitApi::Context::default();
    let result = client.getDescAudioUnitStreamPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor STREAM_PORT_INPUT index
Required
cluster_idx*
Integer
Descriptor AUDIO_CLUSTER index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database

Responses


getDescAudioUnitStreamPortInputAudioMap

Get Descriptor audioUnit/streamPortInput/audioMap


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortInput/{stream_idx}/audioMap/{map_index}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortInput/{stream_idx}/audioMap/{map_index}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

        Integer mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            AUDIO_MAP result = apiInstance.getDescAudioUnitStreamPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitStreamPortInputAudioMap");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

        Integer mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            AUDIO_MAP result = apiInstance.getDescAudioUnitStreamPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitStreamPortInputAudioMap");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor STREAM_PORT_INPUT index
 (default to null)
Integer *mapIndex = 0; // Descriptor AUDIO_MAP index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

// Get Descriptor audioUnit/streamPortInput/audioMap
[apiInstance getDescAudioUnitStreamPortInputAudioMapWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    mapIndex:mapIndex
    entity:entity
              completionHandler: ^(AUDIO_MAP output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor STREAM_PORT_INPUT index

var mapIndex = 0; // {Integer} Descriptor AUDIO_MAP index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescAudioUnitStreamPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescAudioUnitStreamPortInputAudioMapExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor STREAM_PORT_INPUT index
 (default to null)
            var mapIndex = 0;  // Integer | Descriptor AUDIO_MAP index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional)  (default to null)

            try {
                // Get Descriptor audioUnit/streamPortInput/audioMap
                AUDIO_MAP result = apiInstance.getDescAudioUnitStreamPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.getDescAudioUnitStreamPortInputAudioMap: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

$mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


try {
    $result = $api_instance->getDescAudioUnitStreamPortInputAudioMap($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $mapIndex, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->getDescAudioUnitStreamPortInputAudioMap: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor STREAM_PORT_INPUT index

my $mapIndex = 0; # Integer | Descriptor AUDIO_MAP index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


eval { 
    my $result = $api_instance->getDescAudioUnitStreamPortInputAudioMap(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, mapIndex => $mapIndex, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->getDescAudioUnitStreamPortInputAudioMap: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor STREAM_PORT_INPUT index
 (default to null)
mapIndex = 0 # Integer | Descriptor AUDIO_MAP index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

try: 
    # Get Descriptor audioUnit/streamPortInput/audioMap
    api_response = api_instance.get_desc_audio_unit_stream_port_input_audio_map(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->getDescAudioUnitStreamPortInputAudioMap: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let mapIndex = 0; // Integer
    let entity = ; // array[String]

    let mut context = AudioUnitApi::Context::default();
    let result = client.getDescAudioUnitStreamPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor STREAM_PORT_INPUT index
Required
map_index*
Integer
Descriptor AUDIO_MAP index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database

Responses


getDescAudioUnitStreamPortInputControl

Get Descriptor audioUnit/streamPortInput/control


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortInput/{stream_idx}/control/{control_index}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortInput/{stream_idx}/control/{control_index}?entity=&format="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

        Format format = ; // Format | specific value Control Value 

        
        try {
            CONTROL result = apiInstance.getDescAudioUnitStreamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitStreamPortInputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

        Format format = ; // Format | specific value Control Value 

        
        try {
            CONTROL result = apiInstance.getDescAudioUnitStreamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitStreamPortInputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor STREAM_PORT_INPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
 (optional) (default to null)
Format *format = ; // specific value Control Value 
 (optional) (default to null)

// Get Descriptor audioUnit/streamPortInput/control
[apiInstance getDescAudioUnitStreamPortInputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    entity:entity
    format:format
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor STREAM_PORT_INPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var opts = {
  'entity': , // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

  'format':  // {Format} specific value Control Value 

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescAudioUnitStreamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescAudioUnitStreamPortInputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor STREAM_PORT_INPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
 (optional)  (default to null)
            var format = new Format(); // Format | specific value Control Value 
 (optional)  (default to null)

            try {
                // Get Descriptor audioUnit/streamPortInput/control
                CONTROL result = apiInstance.getDescAudioUnitStreamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.getDescAudioUnitStreamPortInputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

$format = ; // Format | specific value Control Value 


try {
    $result = $api_instance->getDescAudioUnitStreamPortInputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $entity, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->getDescAudioUnitStreamPortInputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor STREAM_PORT_INPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

my $format = ; # Format | specific value Control Value 


eval { 
    my $result = $api_instance->getDescAudioUnitStreamPortInputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, entity => $entity, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->getDescAudioUnitStreamPortInputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor STREAM_PORT_INPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
 (optional) (default to null)
format =  # Format | specific value Control Value 
 (optional) (default to null)

try: 
    # Get Descriptor audioUnit/streamPortInput/control
    api_response = api_instance.get_desc_audio_unit_stream_port_input_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity=entity, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->getDescAudioUnitStreamPortInputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let entity = ; // array[String]
    let format = ; // Format

    let mut context = AudioUnitApi::Context::default();
    let result = client.getDescAudioUnitStreamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity, format, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor STREAM_PORT_INPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *value* The **GET_CONTROL** command is used to get the current values of a Control. The get_control command returns the value for the currently active Configuration. The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
format
Format
specific value Control Value

Responses


getDescAudioUnitStreamPortOutput

Get Descriptor audioUnit/streamPortOutput


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortOutput/{stream_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortOutput/{stream_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            STREAM_PORT_OUTPUT result = apiInstance.getDescAudioUnitStreamPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitStreamPortOutput");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            STREAM_PORT_OUTPUT result = apiInstance.getDescAudioUnitStreamPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitStreamPortOutput");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor STREAM_PORT_OUTPUT index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

// Get Descriptor audioUnit/streamPortOutput
[apiInstance getDescAudioUnitStreamPortOutputWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    entity:entity
              completionHandler: ^(STREAM_PORT_OUTPUT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor STREAM_PORT_OUTPUT index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescAudioUnitStreamPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescAudioUnitStreamPortOutputExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor STREAM_PORT_OUTPUT index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional)  (default to null)

            try {
                // Get Descriptor audioUnit/streamPortOutput
                STREAM_PORT_OUTPUT result = apiInstance.getDescAudioUnitStreamPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.getDescAudioUnitStreamPortOutput: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


try {
    $result = $api_instance->getDescAudioUnitStreamPortOutput($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->getDescAudioUnitStreamPortOutput: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor STREAM_PORT_OUTPUT index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


eval { 
    my $result = $api_instance->getDescAudioUnitStreamPortOutput(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->getDescAudioUnitStreamPortOutput: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor STREAM_PORT_OUTPUT index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

try: 
    # Get Descriptor audioUnit/streamPortOutput
    api_response = api_instance.get_desc_audio_unit_stream_port_output(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->getDescAudioUnitStreamPortOutput: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = AudioUnitApi::Context::default();
    let result = client.getDescAudioUnitStreamPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor STREAM_PORT_OUTPUT index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database

Responses


getDescAudioUnitStreamPortOutputAudioCluster

Get Descriptor audioUnit/streamPortOutput/audioCluster


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortOutput/{stream_idx}/audioCluster/{cluster_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortOutput/{stream_idx}/audioCluster/{cluster_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

        Integer clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            AUDIO_CLUSTER result = apiInstance.getDescAudioUnitStreamPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitStreamPortOutputAudioCluster");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

        Integer clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            AUDIO_CLUSTER result = apiInstance.getDescAudioUnitStreamPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitStreamPortOutputAudioCluster");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor STREAM_PORT_OUTPUT index
 (default to null)
Integer *clusterIdx = 0; // Descriptor AUDIO_CLUSTER index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

// Get Descriptor audioUnit/streamPortOutput/audioCluster
[apiInstance getDescAudioUnitStreamPortOutputAudioClusterWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    clusterIdx:clusterIdx
    entity:entity
              completionHandler: ^(AUDIO_CLUSTER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor STREAM_PORT_OUTPUT index

var clusterIdx = 0; // {Integer} Descriptor AUDIO_CLUSTER index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescAudioUnitStreamPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescAudioUnitStreamPortOutputAudioClusterExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor STREAM_PORT_OUTPUT index
 (default to null)
            var clusterIdx = 0;  // Integer | Descriptor AUDIO_CLUSTER index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional)  (default to null)

            try {
                // Get Descriptor audioUnit/streamPortOutput/audioCluster
                AUDIO_CLUSTER result = apiInstance.getDescAudioUnitStreamPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.getDescAudioUnitStreamPortOutputAudioCluster: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

$clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


try {
    $result = $api_instance->getDescAudioUnitStreamPortOutputAudioCluster($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $clusterIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->getDescAudioUnitStreamPortOutputAudioCluster: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor STREAM_PORT_OUTPUT index

my $clusterIdx = 0; # Integer | Descriptor AUDIO_CLUSTER index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


eval { 
    my $result = $api_instance->getDescAudioUnitStreamPortOutputAudioCluster(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, clusterIdx => $clusterIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->getDescAudioUnitStreamPortOutputAudioCluster: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor STREAM_PORT_OUTPUT index
 (default to null)
clusterIdx = 0 # Integer | Descriptor AUDIO_CLUSTER index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

try: 
    # Get Descriptor audioUnit/streamPortOutput/audioCluster
    api_response = api_instance.get_desc_audio_unit_stream_port_output_audio_cluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->getDescAudioUnitStreamPortOutputAudioCluster: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let clusterIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = AudioUnitApi::Context::default();
    let result = client.getDescAudioUnitStreamPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor STREAM_PORT_OUTPUT index
Required
cluster_idx*
Integer
Descriptor AUDIO_CLUSTER index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database

Responses


getDescAudioUnitStreamPortOutputAudioMap

Get Descriptor audioUni/streamPortOutput/audioMap


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortOutput/{stream_idx}/audioMap/{map_index}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortOutput/{stream_idx}/audioMap/{map_index}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

        Integer mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            AUDIO_MAP result = apiInstance.getDescAudioUnitStreamPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitStreamPortOutputAudioMap");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

        Integer mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            AUDIO_MAP result = apiInstance.getDescAudioUnitStreamPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitStreamPortOutputAudioMap");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor STREAM_PORT_OUTPUT index
 (default to null)
Integer *mapIndex = 0; // Descriptor AUDIO_MAP index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

// Get Descriptor audioUni/streamPortOutput/audioMap
[apiInstance getDescAudioUnitStreamPortOutputAudioMapWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    mapIndex:mapIndex
    entity:entity
              completionHandler: ^(AUDIO_MAP output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor STREAM_PORT_OUTPUT index

var mapIndex = 0; // {Integer} Descriptor AUDIO_MAP index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescAudioUnitStreamPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescAudioUnitStreamPortOutputAudioMapExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor STREAM_PORT_OUTPUT index
 (default to null)
            var mapIndex = 0;  // Integer | Descriptor AUDIO_MAP index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional)  (default to null)

            try {
                // Get Descriptor audioUni/streamPortOutput/audioMap
                AUDIO_MAP result = apiInstance.getDescAudioUnitStreamPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.getDescAudioUnitStreamPortOutputAudioMap: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

$mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


try {
    $result = $api_instance->getDescAudioUnitStreamPortOutputAudioMap($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $mapIndex, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->getDescAudioUnitStreamPortOutputAudioMap: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor STREAM_PORT_OUTPUT index

my $mapIndex = 0; # Integer | Descriptor AUDIO_MAP index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


eval { 
    my $result = $api_instance->getDescAudioUnitStreamPortOutputAudioMap(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, mapIndex => $mapIndex, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->getDescAudioUnitStreamPortOutputAudioMap: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor STREAM_PORT_OUTPUT index
 (default to null)
mapIndex = 0 # Integer | Descriptor AUDIO_MAP index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

try: 
    # Get Descriptor audioUni/streamPortOutput/audioMap
    api_response = api_instance.get_desc_audio_unit_stream_port_output_audio_map(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->getDescAudioUnitStreamPortOutputAudioMap: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let mapIndex = 0; // Integer
    let entity = ; // array[String]

    let mut context = AudioUnitApi::Context::default();
    let result = client.getDescAudioUnitStreamPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor STREAM_PORT_OUTPUT index
Required
map_index*
Integer
Descriptor AUDIO_MAP index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database

Responses


getDescAudioUnitStreamPortOutputControl

Get Descriptor audioUnit/streamPortOutput/control


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortOutput/{stream_idx}/control/{control_index}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortOutput/{stream_idx}/control/{control_index}?entity=&format="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

        Format1 format = ; // Format1 | specific value Control Value 

        
        try {
            CONTROL result = apiInstance.getDescAudioUnitStreamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitStreamPortOutputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

        Format1 format = ; // Format1 | specific value Control Value 

        
        try {
            CONTROL result = apiInstance.getDescAudioUnitStreamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#getDescAudioUnitStreamPortOutputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor STREAM_PORT_OUTPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
 (optional) (default to null)
Format1 *format = ; // specific value Control Value 
 (optional) (default to null)

// Get Descriptor audioUnit/streamPortOutput/control
[apiInstance getDescAudioUnitStreamPortOutputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    entity:entity
    format:format
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor STREAM_PORT_OUTPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var opts = {
  'entity': , // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

  'format':  // {Format1} specific value Control Value 

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescAudioUnitStreamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescAudioUnitStreamPortOutputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor STREAM_PORT_OUTPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
 (optional)  (default to null)
            var format = new Format1(); // Format1 | specific value Control Value 
 (optional)  (default to null)

            try {
                // Get Descriptor audioUnit/streamPortOutput/control
                CONTROL result = apiInstance.getDescAudioUnitStreamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.getDescAudioUnitStreamPortOutputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

$format = ; // Format1 | specific value Control Value 


try {
    $result = $api_instance->getDescAudioUnitStreamPortOutputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $entity, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->getDescAudioUnitStreamPortOutputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor STREAM_PORT_OUTPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

my $format = ; # Format1 | specific value Control Value 


eval { 
    my $result = $api_instance->getDescAudioUnitStreamPortOutputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, entity => $entity, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->getDescAudioUnitStreamPortOutputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor STREAM_PORT_OUTPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
 (optional) (default to null)
format =  # Format1 | specific value Control Value 
 (optional) (default to null)

try: 
    # Get Descriptor audioUnit/streamPortOutput/control
    api_response = api_instance.get_desc_audio_unit_stream_port_output_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity=entity, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->getDescAudioUnitStreamPortOutputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let entity = ; // array[String]
    let format = ; // Format1

    let mut context = AudioUnitApi::Context::default();
    let result = client.getDescAudioUnitStreamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, entity, format, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor STREAM_PORT_OUTPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *value* The **GET_CONTROL** command is used to get the current values of a Control. The get_control command returns the value for the currently active Configuration. The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
format
Format1
specific value Control Value

Responses


incrementAudioUnitExternamPortInputControl

Increment audioUnit/externalPortInput/control value

The following objects can be changed and trigger AEM Command on the device. *increment* The **INCREMENT_CONTROL** command is used to increment the specified values of a Control by the Control’s step sizes. The increment_control command acts on a CONTROL descriptor in the current Configuration. An Entity may propagate the format change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. Note that the value only determines the index of control value, which is incremented. In response you will receive the current value, which is determined by the controlValueType. The maximum possible index is the value count described in the descriptor.option you can set the format but also have to specify the value count. The count parameter may only be used with the format parameter. Use this if the entity does not describe it with a descriptor. The values may not be displayed correctly.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortInput/{stream_idx}/control/{control_index}/increment

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortInput/{stream_idx}/control/{control_index}/increment"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.incrementAudioUnitExternamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#incrementAudioUnitExternamPortInputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.incrementAudioUnitExternamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#incrementAudioUnitExternamPortInputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
CONTROLCREMENT *cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; //  (optional)

// Increment audioUnit/externalPortInput/control value
[apiInstance incrementAudioUnitExternamPortInputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    cONTROLCREMENT:cONTROLCREMENT
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor EXTERNAL_PORT_INPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var opts = {
  'cONTROLCREMENT': {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} // {CONTROLCREMENT} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.incrementAudioUnitExternamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class incrementAudioUnitExternamPortInputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var cONTROLCREMENT = new CONTROLCREMENT(); // CONTROLCREMENT |  (optional) 

            try {
                // Increment audioUnit/externalPortInput/control value
                CONTROL result = apiInstance.incrementAudioUnitExternamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.incrementAudioUnitExternamPortInputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 

try {
    $result = $api_instance->incrementAudioUnitExternamPortInputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $cONTROLCREMENT);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->incrementAudioUnitExternamPortInputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor EXTERNAL_PORT_INPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $cONTROLCREMENT = WWW::OPenAPIClient::Object::CONTROLCREMENT->new(); # CONTROLCREMENT | 

eval { 
    my $result = $api_instance->incrementAudioUnitExternamPortInputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, cONTROLCREMENT => $cONTROLCREMENT);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->incrementAudioUnitExternamPortInputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} # CONTROLCREMENT |  (optional)

try: 
    # Increment audioUnit/externalPortInput/control value
    api_response = api_instance.increment_audio_unit_externam_port_input_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT=cONTROLCREMENT)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->incrementAudioUnitExternamPortInputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT

    let mut context = AudioUnitApi::Context::default();
    let result = client.incrementAudioUnitExternamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor EXTERNAL_PORT_INPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Body parameters
Name Description
cONTROLCREMENT

Set Object Name and Control Value

Responses


incrementAudioUnitExternamPortOutputControl

Increment audioUnit/externalPortOutput/control value

The following objects can be changed and trigger AEM Command on the device. *increment* The **INCREMENT_CONTROL** command is used to increment the specified values of a Control by the Control’s step sizes. The increment_control command acts on a CONTROL descriptor in the current Configuration. An Entity may propagate the format change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. Note that the value only determines the index of control value, which is incremented. In response you will receive the current value, which is determined by the controlValueType. The maximum possible index is the value count described in the descriptor.option you can set the format but also have to specify the value count. The count parameter may only be used with the format parameter. Use this if the entity does not describe it with a descriptor. The values may not be displayed correctly.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortOutput/{stream_idx}/control/{control_index}/increment

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortOutput/{stream_idx}/control/{control_index}/increment"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.incrementAudioUnitExternamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#incrementAudioUnitExternamPortOutputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.incrementAudioUnitExternamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#incrementAudioUnitExternamPortOutputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
CONTROLCREMENT *cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; //  (optional)

// Increment audioUnit/externalPortOutput/control value
[apiInstance incrementAudioUnitExternamPortOutputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    cONTROLCREMENT:cONTROLCREMENT
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor EXTERNAL_PORT_OUTPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var opts = {
  'cONTROLCREMENT': {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} // {CONTROLCREMENT} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.incrementAudioUnitExternamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class incrementAudioUnitExternamPortOutputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var cONTROLCREMENT = new CONTROLCREMENT(); // CONTROLCREMENT |  (optional) 

            try {
                // Increment audioUnit/externalPortOutput/control value
                CONTROL result = apiInstance.incrementAudioUnitExternamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.incrementAudioUnitExternamPortOutputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 

try {
    $result = $api_instance->incrementAudioUnitExternamPortOutputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $cONTROLCREMENT);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->incrementAudioUnitExternamPortOutputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor EXTERNAL_PORT_OUTPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $cONTROLCREMENT = WWW::OPenAPIClient::Object::CONTROLCREMENT->new(); # CONTROLCREMENT | 

eval { 
    my $result = $api_instance->incrementAudioUnitExternamPortOutputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, cONTROLCREMENT => $cONTROLCREMENT);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->incrementAudioUnitExternamPortOutputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} # CONTROLCREMENT |  (optional)

try: 
    # Increment audioUnit/externalPortOutput/control value
    api_response = api_instance.increment_audio_unit_externam_port_output_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT=cONTROLCREMENT)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->incrementAudioUnitExternamPortOutputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT

    let mut context = AudioUnitApi::Context::default();
    let result = client.incrementAudioUnitExternamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor EXTERNAL_PORT_OUTPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Body parameters
Name Description
cONTROLCREMENT

Set Object Name and Control Value

Responses


incrementAudioUnitInternalPortInputControl

increment audioUnit/internalPortInput/control value

The following objects can be changed and trigger AEM Command on the device. *increment* The **INCREMENT_CONTROL** command is used to increment the specified values of a Control by the Control’s step sizes. The increment_control command acts on a CONTROL descriptor in the current Configuration. An Entity may propagate the format change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. Note that the value only determines the index of control value, which is incremented. In response you will receive the current value, which is determined by the controlValueType. The maximum possible index is the value count described in the descriptor.option you can set the format but also have to specify the value count. The count parameter may only be used with the format parameter. Use this if the entity does not describe it with a descriptor. The values may not be displayed correctly.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortInput/{stream_idx}/control/{control_index}/increment

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortInput/{stream_idx}/control/{control_index}/increment"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.incrementAudioUnitInternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#incrementAudioUnitInternalPortInputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.incrementAudioUnitInternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#incrementAudioUnitInternalPortInputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor INTERNAL_PORT_INPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
CONTROLCREMENT *cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; //  (optional)

// increment audioUnit/internalPortInput/control value
[apiInstance incrementAudioUnitInternalPortInputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    cONTROLCREMENT:cONTROLCREMENT
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor INTERNAL_PORT_INPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var opts = {
  'cONTROLCREMENT': {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} // {CONTROLCREMENT} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.incrementAudioUnitInternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class incrementAudioUnitInternalPortInputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor INTERNAL_PORT_INPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var cONTROLCREMENT = new CONTROLCREMENT(); // CONTROLCREMENT |  (optional) 

            try {
                // increment audioUnit/internalPortInput/control value
                CONTROL result = apiInstance.incrementAudioUnitInternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.incrementAudioUnitInternalPortInputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 

try {
    $result = $api_instance->incrementAudioUnitInternalPortInputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $cONTROLCREMENT);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->incrementAudioUnitInternalPortInputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor INTERNAL_PORT_INPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $cONTROLCREMENT = WWW::OPenAPIClient::Object::CONTROLCREMENT->new(); # CONTROLCREMENT | 

eval { 
    my $result = $api_instance->incrementAudioUnitInternalPortInputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, cONTROLCREMENT => $cONTROLCREMENT);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->incrementAudioUnitInternalPortInputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor INTERNAL_PORT_INPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} # CONTROLCREMENT |  (optional)

try: 
    # increment audioUnit/internalPortInput/control value
    api_response = api_instance.increment_audio_unit_internal_port_input_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT=cONTROLCREMENT)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->incrementAudioUnitInternalPortInputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT

    let mut context = AudioUnitApi::Context::default();
    let result = client.incrementAudioUnitInternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor INTERNAL_PORT_INPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Body parameters
Name Description
cONTROLCREMENT

Set Object Name and Control Value

Responses


incrementAudioUnitInternalPortOutputControl

increment audioUnit/internalPortOutput/control value

The following objects can be changed and trigger AEM Command on the device. *increment* The **INCREMENT_CONTROL** command is used to increment the specified values of a Control by the Control’s step sizes. The increment_control command acts on a CONTROL descriptor in the current Configuration. An Entity may propagate the format change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. Note that the value only determines the index of control value, which is incremented. In response you will receive the current value, which is determined by the controlValueType. The maximum possible index is the value count described in the descriptor.option you can set the format but also have to specify the value count. The count parameter may only be used with the format parameter. Use this if the entity does not describe it with a descriptor. The values may not be displayed correctly.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortOutput/{stream_idx}/control/{control_index}/increment

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortOutput/{stream_idx}/control/{control_index}/increment"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.incrementAudioUnitInternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#incrementAudioUnitInternalPortOutputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.incrementAudioUnitInternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#incrementAudioUnitInternalPortOutputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
CONTROLCREMENT *cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; //  (optional)

// increment audioUnit/internalPortOutput/control value
[apiInstance incrementAudioUnitInternalPortOutputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    cONTROLCREMENT:cONTROLCREMENT
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor INTERNAL_PORT_OUTPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var opts = {
  'cONTROLCREMENT': {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} // {CONTROLCREMENT} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.incrementAudioUnitInternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class incrementAudioUnitInternalPortOutputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var cONTROLCREMENT = new CONTROLCREMENT(); // CONTROLCREMENT |  (optional) 

            try {
                // increment audioUnit/internalPortOutput/control value
                CONTROL result = apiInstance.incrementAudioUnitInternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.incrementAudioUnitInternalPortOutputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 

try {
    $result = $api_instance->incrementAudioUnitInternalPortOutputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $cONTROLCREMENT);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->incrementAudioUnitInternalPortOutputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor INTERNAL_PORT_OUTPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $cONTROLCREMENT = WWW::OPenAPIClient::Object::CONTROLCREMENT->new(); # CONTROLCREMENT | 

eval { 
    my $result = $api_instance->incrementAudioUnitInternalPortOutputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, cONTROLCREMENT => $cONTROLCREMENT);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->incrementAudioUnitInternalPortOutputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} # CONTROLCREMENT |  (optional)

try: 
    # increment audioUnit/internalPortOutput/control value
    api_response = api_instance.increment_audio_unit_internal_port_output_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT=cONTROLCREMENT)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->incrementAudioUnitInternalPortOutputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT

    let mut context = AudioUnitApi::Context::default();
    let result = client.incrementAudioUnitInternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor INTERNAL_PORT_OUTPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Body parameters
Name Description
cONTROLCREMENT

Set Object Name and Control Value

Responses


incrementAudioUnitStreamPortInputControl

Increment audioUnit/streamPortInput/control

The following objects can be changed and trigger AEM Command on the device. *increment* The **INCREMENT_CONTROL** command is used to increment the specified values of a Control by the Control’s step sizes. The increment_control command acts on a CONTROL descriptor in the current Configuration. An Entity may propagate the format change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. Note that the value only determines the index of control value, which is incremented. In response you will receive the current value, which is determined by the controlValueType. The maximum possible index is the value count described in the descriptor.option you can set the format but also have to specify the value count. The count parameter may only be used with the format parameter. Use this if the entity does not describe it with a descriptor. The values may not be displayed correctly.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortInput/{stream_idx}/control/{control_index}/increment

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortInput/{stream_idx}/control/{control_index}/increment"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.incrementAudioUnitStreamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#incrementAudioUnitStreamPortInputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.incrementAudioUnitStreamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#incrementAudioUnitStreamPortInputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor STREAM_PORT_INPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
CONTROLCREMENT *cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; //  (optional)

// Increment audioUnit/streamPortInput/control
[apiInstance incrementAudioUnitStreamPortInputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    cONTROLCREMENT:cONTROLCREMENT
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor STREAM_PORT_INPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var opts = {
  'cONTROLCREMENT': {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} // {CONTROLCREMENT} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.incrementAudioUnitStreamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class incrementAudioUnitStreamPortInputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor STREAM_PORT_INPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var cONTROLCREMENT = new CONTROLCREMENT(); // CONTROLCREMENT |  (optional) 

            try {
                // Increment audioUnit/streamPortInput/control
                CONTROL result = apiInstance.incrementAudioUnitStreamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.incrementAudioUnitStreamPortInputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 

try {
    $result = $api_instance->incrementAudioUnitStreamPortInputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $cONTROLCREMENT);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->incrementAudioUnitStreamPortInputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor STREAM_PORT_INPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $cONTROLCREMENT = WWW::OPenAPIClient::Object::CONTROLCREMENT->new(); # CONTROLCREMENT | 

eval { 
    my $result = $api_instance->incrementAudioUnitStreamPortInputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, cONTROLCREMENT => $cONTROLCREMENT);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->incrementAudioUnitStreamPortInputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor STREAM_PORT_INPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} # CONTROLCREMENT |  (optional)

try: 
    # Increment audioUnit/streamPortInput/control
    api_response = api_instance.increment_audio_unit_stream_port_input_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT=cONTROLCREMENT)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->incrementAudioUnitStreamPortInputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT

    let mut context = AudioUnitApi::Context::default();
    let result = client.incrementAudioUnitStreamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor STREAM_PORT_INPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Body parameters
Name Description
cONTROLCREMENT

Set Object Name and Control Value

Responses


incrementAudioUnitStreamPortOutputControl

increment Descriptor audioUnit/streamPortOutput/control values

The following objects can be changed and trigger AEM Command on the device. *increment* The **INCREMENT_CONTROL** command is used to increment the specified values of a Control by the Control’s step sizes. The increment_control command acts on a CONTROL descriptor in the current Configuration. An Entity may propagate the format change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. Note that the value only determines the index of control value, which is incremented. In response you will receive the current value, which is determined by the controlValueType. The maximum possible index is the value count described in the descriptor.option you can set the format but also have to specify the value count. The count parameter may only be used with the format parameter. Use this if the entity does not describe it with a descriptor. The values may not be displayed correctly.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortOutput/{stream_idx}/control/{control_index}/increment

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortOutput/{stream_idx}/control/{control_index}/increment"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.incrementAudioUnitStreamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#incrementAudioUnitStreamPortOutputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.incrementAudioUnitStreamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#incrementAudioUnitStreamPortOutputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor STREAM_PORT_OUTPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
CONTROLCREMENT *cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; //  (optional)

// increment Descriptor  audioUnit/streamPortOutput/control values
[apiInstance incrementAudioUnitStreamPortOutputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    cONTROLCREMENT:cONTROLCREMENT
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor STREAM_PORT_OUTPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var opts = {
  'cONTROLCREMENT': {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} // {CONTROLCREMENT} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.incrementAudioUnitStreamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class incrementAudioUnitStreamPortOutputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor STREAM_PORT_OUTPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var cONTROLCREMENT = new CONTROLCREMENT(); // CONTROLCREMENT |  (optional) 

            try {
                // increment Descriptor  audioUnit/streamPortOutput/control values
                CONTROL result = apiInstance.incrementAudioUnitStreamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.incrementAudioUnitStreamPortOutputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 

try {
    $result = $api_instance->incrementAudioUnitStreamPortOutputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $cONTROLCREMENT);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->incrementAudioUnitStreamPortOutputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor STREAM_PORT_OUTPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $cONTROLCREMENT = WWW::OPenAPIClient::Object::CONTROLCREMENT->new(); # CONTROLCREMENT | 

eval { 
    my $result = $api_instance->incrementAudioUnitStreamPortOutputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, cONTROLCREMENT => $cONTROLCREMENT);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->incrementAudioUnitStreamPortOutputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor STREAM_PORT_OUTPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} # CONTROLCREMENT |  (optional)

try: 
    # increment Descriptor  audioUnit/streamPortOutput/control values
    api_response = api_instance.increment_audio_unit_stream_port_output_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT=cONTROLCREMENT)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->incrementAudioUnitStreamPortOutputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT

    let mut context = AudioUnitApi::Context::default();
    let result = client.incrementAudioUnitStreamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROLCREMENT, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor STREAM_PORT_OUTPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Body parameters
Name Description
cONTROLCREMENT

Set Object Name and Control Value

Responses


modifyDescAudioUnit

modify Descriptor audioUnit

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command. *currentSampleRate* The **SET_SAMPLE_RATE** command is used to change the sampling rate of a Port or Unit. The **SET_SAMPLE_RATE** command acts on a descriptor in the current Configuration. An Entity may propagate the format change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{unit_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{unit_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer unitIdx = 0; // Integer | Valid top level descriptor index

        AUDIOUNIT1 aUDIOUNIT1 = {AUDIO_UNIT={objectName=Audio Unit 0}}; // AUDIOUNIT1 | 
        
        try {
            AUDIO_UNIT result = apiInstance.modifyDescAudioUnit(deviceId, cfgIdx, unitIdx, aUDIOUNIT1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#modifyDescAudioUnit");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer unitIdx = 0; // Integer | Valid top level descriptor index

        AUDIOUNIT1 aUDIOUNIT1 = {AUDIO_UNIT={objectName=Audio Unit 0}}; // AUDIOUNIT1 | 
        
        try {
            AUDIO_UNIT result = apiInstance.modifyDescAudioUnit(deviceId, cfgIdx, unitIdx, aUDIOUNIT1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#modifyDescAudioUnit");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *unitIdx = 0; // Valid top level descriptor index
 (default to null)
AUDIOUNIT1 *aUDIOUNIT1 = {AUDIO_UNIT={objectName=Audio Unit 0}}; //  (optional)

// modify Descriptor audioUnit
[apiInstance modifyDescAudioUnitWith:deviceId
    cfgIdx:cfgIdx
    unitIdx:unitIdx
    aUDIOUNIT1:aUDIOUNIT1
              completionHandler: ^(AUDIO_UNIT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var unitIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'aUDIOUNIT1': {AUDIO_UNIT={objectName=Audio Unit 0}} // {AUDIOUNIT1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyDescAudioUnit(deviceId, cfgIdx, unitIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyDescAudioUnitExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var unitIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var aUDIOUNIT1 = new AUDIOUNIT1(); // AUDIOUNIT1 |  (optional) 

            try {
                // modify Descriptor audioUnit
                AUDIO_UNIT result = apiInstance.modifyDescAudioUnit(deviceId, cfgIdx, unitIdx, aUDIOUNIT1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.modifyDescAudioUnit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$unitIdx = 0; // Integer | Valid top level descriptor index

$aUDIOUNIT1 = {AUDIO_UNIT={objectName=Audio Unit 0}}; // AUDIOUNIT1 | 

try {
    $result = $api_instance->modifyDescAudioUnit($deviceId, $cfgIdx, $unitIdx, $aUDIOUNIT1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->modifyDescAudioUnit: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $unitIdx = 0; # Integer | Valid top level descriptor index

my $aUDIOUNIT1 = WWW::OPenAPIClient::Object::AUDIOUNIT1->new(); # AUDIOUNIT1 | 

eval { 
    my $result = $api_instance->modifyDescAudioUnit(deviceId => $deviceId, cfgIdx => $cfgIdx, unitIdx => $unitIdx, aUDIOUNIT1 => $aUDIOUNIT1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->modifyDescAudioUnit: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
unitIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
aUDIOUNIT1 = {AUDIO_UNIT={objectName=Audio Unit 0}} # AUDIOUNIT1 |  (optional)

try: 
    # modify Descriptor audioUnit
    api_response = api_instance.modify_desc_audio_unit(deviceId, cfgIdx, unitIdx, aUDIOUNIT1=aUDIOUNIT1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->modifyDescAudioUnit: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let unitIdx = 0; // Integer
    let aUDIOUNIT1 = {AUDIO_UNIT={objectName=Audio Unit 0}}; // AUDIOUNIT1

    let mut context = AudioUnitApi::Context::default();
    let result = client.modifyDescAudioUnit(deviceId, cfgIdx, unitIdx, aUDIOUNIT1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
unit_idx*
Integer
Valid top level descriptor index
Required
Body parameters
Name Description
aUDIOUNIT1

Patch variable Values

Responses


modifyDescAudioUnitExternalPortInputControl

modify Descriptor audioUnit/externalPortInput/control value

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command. *value* The **SET_CONTROL** command is used to change the values of a Control. The set_control command acts on a descriptor in the current Configuration. An AVDECC Entity may propagate the value change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. The parameters depend on the controlValueType, please look in the extended documentation for which parameters can be set. option you can set the controlValType but also have to specify the value count. The count parameter may only be used with the format parameter. Use this if the entity does not describe it with a descriptor. The values may not be displayed correctly.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortInput/{stream_idx}/control/{control_index}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortInput/{stream_idx}/control/{control_index}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROL1 cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1 | 
        
        try {
            CONTROL result = apiInstance.modifyDescAudioUnitExternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#modifyDescAudioUnitExternalPortInputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROL1 cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1 | 
        
        try {
            CONTROL result = apiInstance.modifyDescAudioUnitExternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#modifyDescAudioUnitExternalPortInputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
CONTROL1 *cONTROL1 = {CONTROL={objectName=Control 0}}; //  (optional)

// modify Descriptor audioUnit/externalPortInput/control value
[apiInstance modifyDescAudioUnitExternalPortInputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    cONTROL1:cONTROL1
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor EXTERNAL_PORT_INPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var opts = {
  'cONTROL1': {CONTROL={objectName=Control 0}} // {CONTROL1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyDescAudioUnitExternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyDescAudioUnitExternalPortInputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var cONTROL1 = new CONTROL1(); // CONTROL1 |  (optional) 

            try {
                // modify Descriptor audioUnit/externalPortInput/control value
                CONTROL result = apiInstance.modifyDescAudioUnitExternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.modifyDescAudioUnitExternalPortInputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1 | 

try {
    $result = $api_instance->modifyDescAudioUnitExternalPortInputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $cONTROL1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->modifyDescAudioUnitExternalPortInputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor EXTERNAL_PORT_INPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $cONTROL1 = WWW::OPenAPIClient::Object::CONTROL1->new(); # CONTROL1 | 

eval { 
    my $result = $api_instance->modifyDescAudioUnitExternalPortInputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, cONTROL1 => $cONTROL1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->modifyDescAudioUnitExternalPortInputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
cONTROL1 = {CONTROL={objectName=Control 0}} # CONTROL1 |  (optional)

try: 
    # modify Descriptor audioUnit/externalPortInput/control value
    api_response = api_instance.modify_desc_audio_unit_external_port_input_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1=cONTROL1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->modifyDescAudioUnitExternalPortInputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1

    let mut context = AudioUnitApi::Context::default();
    let result = client.modifyDescAudioUnitExternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor EXTERNAL_PORT_INPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Body parameters
Name Description
cONTROL1

Set Object Name and Control Value

Responses


modifyDescAudioUnitExternalPortOutputControl

modify Descriptor audioUnit/externalPortOutput/control values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command. *value* The **SET_CONTROL** command is used to change the values of a Control. The set_control command acts on a descriptor in the current Configuration. An AVDECC Entity may propagate the value change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. The parameters depend on the controlValueType, please look in the extended documentation for which parameters can be set. option you can set the controlValType but also have to specify the value count. The count parameter may only be used with the format parameter. Use this if the entity does not describe it with a descriptor. The values may not be displayed correctly.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortOutput/{stream_idx}/control/{control_index}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortOutput/{stream_idx}/control/{control_index}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROL1 cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1 | 
        
        try {
            CONTROL result = apiInstance.modifyDescAudioUnitExternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#modifyDescAudioUnitExternalPortOutputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROL1 cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1 | 
        
        try {
            CONTROL result = apiInstance.modifyDescAudioUnitExternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#modifyDescAudioUnitExternalPortOutputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
CONTROL1 *cONTROL1 = {CONTROL={objectName=Control 0}}; //  (optional)

// modify Descriptor audioUnit/externalPortOutput/control values
[apiInstance modifyDescAudioUnitExternalPortOutputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    cONTROL1:cONTROL1
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor EXTERNAL_PORT_OUTPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var opts = {
  'cONTROL1': {CONTROL={objectName=Control 0}} // {CONTROL1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyDescAudioUnitExternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyDescAudioUnitExternalPortOutputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var cONTROL1 = new CONTROL1(); // CONTROL1 |  (optional) 

            try {
                // modify Descriptor audioUnit/externalPortOutput/control values
                CONTROL result = apiInstance.modifyDescAudioUnitExternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.modifyDescAudioUnitExternalPortOutputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1 | 

try {
    $result = $api_instance->modifyDescAudioUnitExternalPortOutputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $cONTROL1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->modifyDescAudioUnitExternalPortOutputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor EXTERNAL_PORT_OUTPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $cONTROL1 = WWW::OPenAPIClient::Object::CONTROL1->new(); # CONTROL1 | 

eval { 
    my $result = $api_instance->modifyDescAudioUnitExternalPortOutputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, cONTROL1 => $cONTROL1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->modifyDescAudioUnitExternalPortOutputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
cONTROL1 = {CONTROL={objectName=Control 0}} # CONTROL1 |  (optional)

try: 
    # modify Descriptor audioUnit/externalPortOutput/control values
    api_response = api_instance.modify_desc_audio_unit_external_port_output_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1=cONTROL1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->modifyDescAudioUnitExternalPortOutputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1

    let mut context = AudioUnitApi::Context::default();
    let result = client.modifyDescAudioUnitExternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor EXTERNAL_PORT_OUTPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Body parameters
Name Description
cONTROL1

Set Object Name and Control Value

Responses


modifyDescAudioUnitInternalPortInputControl

modify Descriptor audioUnit/internalPortInput/control values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command. *value* The **SET_CONTROL** command is used to change the values of a Control. The set_control command acts on a descriptor in the current Configuration. An AVDECC Entity may propagate the value change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. The parameters depend on the controlValueType, please look in the extended documentation for which parameters can be set. option you can set the controlValType but also have to specify the value count. The count parameter may only be used with the format parameter. Use this if the entity does not describe it with a descriptor. The values may not be displayed correctly.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortInput/{stream_idx}/control/{control_index}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortInput/{stream_idx}/control/{control_index}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROL1 cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1 | 
        
        try {
            CONTROL result = apiInstance.modifyDescAudioUnitInternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#modifyDescAudioUnitInternalPortInputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROL1 cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1 | 
        
        try {
            CONTROL result = apiInstance.modifyDescAudioUnitInternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#modifyDescAudioUnitInternalPortInputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor INTERNAL_PORT_INPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
CONTROL1 *cONTROL1 = {CONTROL={objectName=Control 0}}; //  (optional)

// modify Descriptor audioUnit/internalPortInput/control values
[apiInstance modifyDescAudioUnitInternalPortInputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    cONTROL1:cONTROL1
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor INTERNAL_PORT_INPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var opts = {
  'cONTROL1': {CONTROL={objectName=Control 0}} // {CONTROL1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyDescAudioUnitInternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyDescAudioUnitInternalPortInputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor INTERNAL_PORT_INPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var cONTROL1 = new CONTROL1(); // CONTROL1 |  (optional) 

            try {
                // modify Descriptor audioUnit/internalPortInput/control values
                CONTROL result = apiInstance.modifyDescAudioUnitInternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.modifyDescAudioUnitInternalPortInputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1 | 

try {
    $result = $api_instance->modifyDescAudioUnitInternalPortInputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $cONTROL1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->modifyDescAudioUnitInternalPortInputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor INTERNAL_PORT_INPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $cONTROL1 = WWW::OPenAPIClient::Object::CONTROL1->new(); # CONTROL1 | 

eval { 
    my $result = $api_instance->modifyDescAudioUnitInternalPortInputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, cONTROL1 => $cONTROL1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->modifyDescAudioUnitInternalPortInputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor INTERNAL_PORT_INPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
cONTROL1 = {CONTROL={objectName=Control 0}} # CONTROL1 |  (optional)

try: 
    # modify Descriptor audioUnit/internalPortInput/control values
    api_response = api_instance.modify_desc_audio_unit_internal_port_input_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1=cONTROL1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->modifyDescAudioUnitInternalPortInputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1

    let mut context = AudioUnitApi::Context::default();
    let result = client.modifyDescAudioUnitInternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor INTERNAL_PORT_INPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Body parameters
Name Description
cONTROL1

Set Object Name and Control Value

Responses


modifyDescAudioUnitInternalPortOutputControl

modify Descriptor audioUnit/internalPortOutput/control values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command. *value* The **SET_CONTROL** command is used to change the values of a Control. The set_control command acts on a descriptor in the current Configuration. An AVDECC Entity may propagate the value change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. The parameters depend on the controlValueType, please look in the extended documentation for which parameters can be set. option you can set the controlValType but also have to specify the value count. The count parameter may only be used with the format parameter. Use this if the entity does not describe it with a descriptor. The values may not be displayed correctly.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortOutput/{stream_idx}/control/{control_index}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortOutput/{stream_idx}/control/{control_index}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROL1 cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1 | 
        
        try {
            CONTROL result = apiInstance.modifyDescAudioUnitInternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#modifyDescAudioUnitInternalPortOutputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROL1 cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1 | 
        
        try {
            CONTROL result = apiInstance.modifyDescAudioUnitInternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#modifyDescAudioUnitInternalPortOutputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
CONTROL1 *cONTROL1 = {CONTROL={objectName=Control 0}}; //  (optional)

// modify Descriptor audioUnit/internalPortOutput/control values
[apiInstance modifyDescAudioUnitInternalPortOutputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    cONTROL1:cONTROL1
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor INTERNAL_PORT_OUTPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var opts = {
  'cONTROL1': {CONTROL={objectName=Control 0}} // {CONTROL1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyDescAudioUnitInternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyDescAudioUnitInternalPortOutputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var cONTROL1 = new CONTROL1(); // CONTROL1 |  (optional) 

            try {
                // modify Descriptor audioUnit/internalPortOutput/control values
                CONTROL result = apiInstance.modifyDescAudioUnitInternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.modifyDescAudioUnitInternalPortOutputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1 | 

try {
    $result = $api_instance->modifyDescAudioUnitInternalPortOutputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $cONTROL1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->modifyDescAudioUnitInternalPortOutputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor INTERNAL_PORT_OUTPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $cONTROL1 = WWW::OPenAPIClient::Object::CONTROL1->new(); # CONTROL1 | 

eval { 
    my $result = $api_instance->modifyDescAudioUnitInternalPortOutputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, cONTROL1 => $cONTROL1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->modifyDescAudioUnitInternalPortOutputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
cONTROL1 = {CONTROL={objectName=Control 0}} # CONTROL1 |  (optional)

try: 
    # modify Descriptor audioUnit/internalPortOutput/control values
    api_response = api_instance.modify_desc_audio_unit_internal_port_output_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1=cONTROL1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->modifyDescAudioUnitInternalPortOutputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1

    let mut context = AudioUnitApi::Context::default();
    let result = client.modifyDescAudioUnitInternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor INTERNAL_PORT_OUTPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Body parameters
Name Description
cONTROL1

Set Object Name and Control Value

Responses


modifyDescAudioUnitStreamPortInputControl

modify Descriptor audioUnit/streamPortInput/control

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command. *value* The **SET_CONTROL** command is used to change the values of a Control. The set_control command acts on a descriptor in the current Configuration. An AVDECC Entity may propagate the value change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. The parameters depend on the controlValueType, please look in the extended documentation for which parameters can be set. option you can set the controlValType but also have to specify the value count. The count parameter may only be used with the format parameter. Use this if the entity does not describe it with a descriptor. The values may not be displayed correctly.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortInput/{stream_idx}/control/{control_index}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortInput/{stream_idx}/control/{control_index}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROL1 cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1 | 
        
        try {
            CONTROL result = apiInstance.modifyDescAudioUnitStreamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#modifyDescAudioUnitStreamPortInputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROL1 cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1 | 
        
        try {
            CONTROL result = apiInstance.modifyDescAudioUnitStreamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#modifyDescAudioUnitStreamPortInputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor STREAM_PORT_INPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
CONTROL1 *cONTROL1 = {CONTROL={objectName=Control 0}}; //  (optional)

// modify Descriptor audioUnit/streamPortInput/control
[apiInstance modifyDescAudioUnitStreamPortInputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    cONTROL1:cONTROL1
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor STREAM_PORT_INPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var opts = {
  'cONTROL1': {CONTROL={objectName=Control 0}} // {CONTROL1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyDescAudioUnitStreamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyDescAudioUnitStreamPortInputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor STREAM_PORT_INPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var cONTROL1 = new CONTROL1(); // CONTROL1 |  (optional) 

            try {
                // modify Descriptor audioUnit/streamPortInput/control
                CONTROL result = apiInstance.modifyDescAudioUnitStreamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.modifyDescAudioUnitStreamPortInputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1 | 

try {
    $result = $api_instance->modifyDescAudioUnitStreamPortInputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $cONTROL1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->modifyDescAudioUnitStreamPortInputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor STREAM_PORT_INPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $cONTROL1 = WWW::OPenAPIClient::Object::CONTROL1->new(); # CONTROL1 | 

eval { 
    my $result = $api_instance->modifyDescAudioUnitStreamPortInputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, cONTROL1 => $cONTROL1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->modifyDescAudioUnitStreamPortInputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor STREAM_PORT_INPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
cONTROL1 = {CONTROL={objectName=Control 0}} # CONTROL1 |  (optional)

try: 
    # modify Descriptor audioUnit/streamPortInput/control
    api_response = api_instance.modify_desc_audio_unit_stream_port_input_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1=cONTROL1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->modifyDescAudioUnitStreamPortInputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1

    let mut context = AudioUnitApi::Context::default();
    let result = client.modifyDescAudioUnitStreamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor STREAM_PORT_INPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Body parameters
Name Description
cONTROL1

Set Object Name and Control Value

Responses


modifyDescAudioUnitStreamPortOutput/control

modify Descriptor audioUnit/streamPortOutput/control

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command. *value* The **SET_CONTROL** command is used to change the values of a Control. The set_control command acts on a descriptor in the current Configuration. An AVDECC Entity may propagate the value change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. The parameters depend on the controlValueType, please look in the extended documentation for which parameters can be set. option you can set the controlValType but also have to specify the value count. The count parameter may only be used with the format parameter. Use this if the entity does not describe it with a descriptor. The values may not be displayed correctly.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortOutput/{stream_idx}/control/{control_index}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortOutput/{stream_idx}/control/{control_index}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROL1 cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1 | 
        
        try {
            CONTROL result = apiInstance.modifyDescAudioUnitStreamPortOutput/control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#modifyDescAudioUnitStreamPortOutput/control");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        CONTROL1 cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1 | 
        
        try {
            CONTROL result = apiInstance.modifyDescAudioUnitStreamPortOutput/control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#modifyDescAudioUnitStreamPortOutput/control");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor STREAM_PORT_OUTPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
CONTROL1 *cONTROL1 = {CONTROL={objectName=Control 0}}; //  (optional)

// modify Descriptor audioUnit/streamPortOutput/control
[apiInstance modifyDescAudioUnitStreamPortOutput/controlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    cONTROL1:cONTROL1
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor STREAM_PORT_OUTPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var opts = {
  'cONTROL1': {CONTROL={objectName=Control 0}} // {CONTROL1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyDescAudioUnitStreamPortOutput/control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyDescAudioUnitStreamPortOutput/controlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor STREAM_PORT_OUTPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var cONTROL1 = new CONTROL1(); // CONTROL1 |  (optional) 

            try {
                // modify Descriptor audioUnit/streamPortOutput/control
                CONTROL result = apiInstance.modifyDescAudioUnitStreamPortOutput/control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.modifyDescAudioUnitStreamPortOutput/control: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1 | 

try {
    $result = $api_instance->modifyDescAudioUnitStreamPortOutput/control($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $cONTROL1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->modifyDescAudioUnitStreamPortOutput/control: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor STREAM_PORT_OUTPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $cONTROL1 = WWW::OPenAPIClient::Object::CONTROL1->new(); # CONTROL1 | 

eval { 
    my $result = $api_instance->modifyDescAudioUnitStreamPortOutput/control(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, cONTROL1 => $cONTROL1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->modifyDescAudioUnitStreamPortOutput/control: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor STREAM_PORT_OUTPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
cONTROL1 = {CONTROL={objectName=Control 0}} # CONTROL1 |  (optional)

try: 
    # modify Descriptor audioUnit/streamPortOutput/control
    api_response = api_instance.modify_desc_audio_unit_stream_port_output/control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1=cONTROL1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->modifyDescAudioUnitStreamPortOutput/control: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1

    let mut context = AudioUnitApi::Context::default();
    let result = client.modifyDescAudioUnitStreamPortOutput/control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, cONTROL1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor STREAM_PORT_OUTPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Body parameters
Name Description
cONTROL1

Set Object Name and Control Value

Responses


writeDescAudioUnit

Write Descriptor audioUnit

The **WRITE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{unit_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{unit_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer unitIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AUDIO_UNIT result = apiInstance.writeDescAudioUnit(deviceId, cfgIdx, unitIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnit");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer unitIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AUDIO_UNIT result = apiInstance.writeDescAudioUnit(deviceId, cfgIdx, unitIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnit");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *unitIdx = 0; // Valid top level descriptor index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor audioUnit
[apiInstance writeDescAudioUnitWith:deviceId
    cfgIdx:cfgIdx
    unitIdx:unitIdx
    length:length
    data:data
              completionHandler: ^(AUDIO_UNIT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var unitIdx = 0; // {Integer} Valid top level descriptor index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescAudioUnit(deviceId, cfgIdx, unitIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescAudioUnitExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var unitIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor audioUnit
                AUDIO_UNIT result = apiInstance.writeDescAudioUnit(deviceId, cfgIdx, unitIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.writeDescAudioUnit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$unitIdx = 0; // Integer | Valid top level descriptor index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescAudioUnit($deviceId, $cfgIdx, $unitIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->writeDescAudioUnit: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $unitIdx = 0; # Integer | Valid top level descriptor index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescAudioUnit(deviceId => $deviceId, cfgIdx => $cfgIdx, unitIdx => $unitIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->writeDescAudioUnit: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
unitIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor audioUnit
    api_response = api_instance.write_desc_audio_unit(deviceId, cfgIdx, unitIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->writeDescAudioUnit: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let unitIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = AudioUnitApi::Context::default();
    let result = client.writeDescAudioUnit(deviceId, cfgIdx, unitIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
unit_idx*
Integer
Valid top level descriptor index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


writeDescAudioUnitExternalPortInput

Write Descriptor audioUnit/externalPortInput

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortInput/{stream_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortInput/{stream_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            EXTERNAL_PORT_INPUT result = apiInstance.writeDescAudioUnitExternalPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitExternalPortInput");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            EXTERNAL_PORT_INPUT result = apiInstance.writeDescAudioUnitExternalPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitExternalPortInput");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor audioUnit/externalPortInput
[apiInstance writeDescAudioUnitExternalPortInputWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    length:length
    data:data
              completionHandler: ^(EXTERNAL_PORT_INPUT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor EXTERNAL_PORT_INPUT index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescAudioUnitExternalPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescAudioUnitExternalPortInputExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor audioUnit/externalPortInput
                EXTERNAL_PORT_INPUT result = apiInstance.writeDescAudioUnitExternalPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.writeDescAudioUnitExternalPortInput: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescAudioUnitExternalPortInput($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->writeDescAudioUnitExternalPortInput: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor EXTERNAL_PORT_INPUT index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescAudioUnitExternalPortInput(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->writeDescAudioUnitExternalPortInput: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor audioUnit/externalPortInput
    api_response = api_instance.write_desc_audio_unit_external_port_input(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->writeDescAudioUnitExternalPortInput: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = AudioUnitApi::Context::default();
    let result = client.writeDescAudioUnitExternalPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor EXTERNAL_PORT_INPUT index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


writeDescAudioUnitExternalPortInputAudioCluster

Write Descriptor audioUnit/externalPortInput/audioCluster

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortInput/{stream_idx}/audioCluster/{cluster_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortInput/{stream_idx}/audioCluster/{cluster_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

        Integer clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AUDIO_CLUSTER result = apiInstance.writeDescAudioUnitExternalPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitExternalPortInputAudioCluster");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

        Integer clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AUDIO_CLUSTER result = apiInstance.writeDescAudioUnitExternalPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitExternalPortInputAudioCluster");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
Integer *clusterIdx = 0; // Descriptor AUDIO_CLUSTER index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor audioUnit/externalPortInput/audioCluster
[apiInstance writeDescAudioUnitExternalPortInputAudioClusterWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    clusterIdx:clusterIdx
    length:length
    data:data
              completionHandler: ^(AUDIO_CLUSTER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor EXTERNAL_PORT_INPUT index

var clusterIdx = 0; // {Integer} Descriptor AUDIO_CLUSTER index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescAudioUnitExternalPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescAudioUnitExternalPortInputAudioClusterExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
            var clusterIdx = 0;  // Integer | Descriptor AUDIO_CLUSTER index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor audioUnit/externalPortInput/audioCluster
                AUDIO_CLUSTER result = apiInstance.writeDescAudioUnitExternalPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.writeDescAudioUnitExternalPortInputAudioCluster: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

$clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescAudioUnitExternalPortInputAudioCluster($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $clusterIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->writeDescAudioUnitExternalPortInputAudioCluster: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor EXTERNAL_PORT_INPUT index

my $clusterIdx = 0; # Integer | Descriptor AUDIO_CLUSTER index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescAudioUnitExternalPortInputAudioCluster(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, clusterIdx => $clusterIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->writeDescAudioUnitExternalPortInputAudioCluster: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
clusterIdx = 0 # Integer | Descriptor AUDIO_CLUSTER index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor audioUnit/externalPortInput/audioCluster
    api_response = api_instance.write_desc_audio_unit_external_port_input_audio_cluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->writeDescAudioUnitExternalPortInputAudioCluster: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let clusterIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = AudioUnitApi::Context::default();
    let result = client.writeDescAudioUnitExternalPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor EXTERNAL_PORT_INPUT index
Required
cluster_idx*
Integer
Descriptor AUDIO_CLUSTER index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


writeDescAudioUnitExternalPortInputAudioMap

Write Descriptor audioUnit/externalPortInputAudioMap

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortInput/{stream_idx}/audioMap/{map_index}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortInput/{stream_idx}/audioMap/{map_index}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

        Integer mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AUDIO_MAP result = apiInstance.writeDescAudioUnitExternalPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitExternalPortInputAudioMap");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

        Integer mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AUDIO_MAP result = apiInstance.writeDescAudioUnitExternalPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitExternalPortInputAudioMap");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
Integer *mapIndex = 0; // Descriptor AUDIO_MAP index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor audioUnit/externalPortInputAudioMap
[apiInstance writeDescAudioUnitExternalPortInputAudioMapWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    mapIndex:mapIndex
    length:length
    data:data
              completionHandler: ^(AUDIO_MAP output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor EXTERNAL_PORT_INPUT index

var mapIndex = 0; // {Integer} Descriptor AUDIO_MAP index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescAudioUnitExternalPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescAudioUnitExternalPortInputAudioMapExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
            var mapIndex = 0;  // Integer | Descriptor AUDIO_MAP index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor audioUnit/externalPortInputAudioMap
                AUDIO_MAP result = apiInstance.writeDescAudioUnitExternalPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.writeDescAudioUnitExternalPortInputAudioMap: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

$mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescAudioUnitExternalPortInputAudioMap($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $mapIndex, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->writeDescAudioUnitExternalPortInputAudioMap: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor EXTERNAL_PORT_INPUT index

my $mapIndex = 0; # Integer | Descriptor AUDIO_MAP index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescAudioUnitExternalPortInputAudioMap(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, mapIndex => $mapIndex, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->writeDescAudioUnitExternalPortInputAudioMap: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
mapIndex = 0 # Integer | Descriptor AUDIO_MAP index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor audioUnit/externalPortInputAudioMap
    api_response = api_instance.write_desc_audio_unit_external_port_input_audio_map(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->writeDescAudioUnitExternalPortInputAudioMap: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let mapIndex = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = AudioUnitApi::Context::default();
    let result = client.writeDescAudioUnitExternalPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor EXTERNAL_PORT_INPUT index
Required
map_index*
Integer
Descriptor AUDIO_MAP index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


writeDescAudioUnitExternalPortInputControl

Write Descriptor audioUnit/externalPortInput/control

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortInput/{stream_idx}/control/{control_index}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortInput/{stream_idx}/control/{control_index}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            CONTROL result = apiInstance.writeDescAudioUnitExternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitExternalPortInputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            CONTROL result = apiInstance.writeDescAudioUnitExternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitExternalPortInputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor audioUnit/externalPortInput/control
[apiInstance writeDescAudioUnitExternalPortInputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    length:length
    data:data
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor EXTERNAL_PORT_INPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescAudioUnitExternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescAudioUnitExternalPortInputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor audioUnit/externalPortInput/control
                CONTROL result = apiInstance.writeDescAudioUnitExternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.writeDescAudioUnitExternalPortInputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_INPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescAudioUnitExternalPortInputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->writeDescAudioUnitExternalPortInputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor EXTERNAL_PORT_INPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescAudioUnitExternalPortInputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->writeDescAudioUnitExternalPortInputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor EXTERNAL_PORT_INPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor audioUnit/externalPortInput/control
    api_response = api_instance.write_desc_audio_unit_external_port_input_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->writeDescAudioUnitExternalPortInputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = AudioUnitApi::Context::default();
    let result = client.writeDescAudioUnitExternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor EXTERNAL_PORT_INPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


writeDescAudioUnitExternalPortOutput

Write Descriptor audioUnit/externalPortOutput

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortOutput/{stream_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortOutput/{stream_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            EXTERNAL_PORT_OUTPUT result = apiInstance.writeDescAudioUnitExternalPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitExternalPortOutput");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            EXTERNAL_PORT_OUTPUT result = apiInstance.writeDescAudioUnitExternalPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitExternalPortOutput");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor audioUnit/externalPortOutput
[apiInstance writeDescAudioUnitExternalPortOutputWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    length:length
    data:data
              completionHandler: ^(EXTERNAL_PORT_OUTPUT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor EXTERNAL_PORT_OUTPUT index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescAudioUnitExternalPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescAudioUnitExternalPortOutputExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor audioUnit/externalPortOutput
                EXTERNAL_PORT_OUTPUT result = apiInstance.writeDescAudioUnitExternalPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.writeDescAudioUnitExternalPortOutput: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescAudioUnitExternalPortOutput($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->writeDescAudioUnitExternalPortOutput: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor EXTERNAL_PORT_OUTPUT index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescAudioUnitExternalPortOutput(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->writeDescAudioUnitExternalPortOutput: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor audioUnit/externalPortOutput
    api_response = api_instance.write_desc_audio_unit_external_port_output(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->writeDescAudioUnitExternalPortOutput: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = AudioUnitApi::Context::default();
    let result = client.writeDescAudioUnitExternalPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor EXTERNAL_PORT_OUTPUT index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


writeDescAudioUnitExternalPortOutputAudioCluster

Write Descriptor audioUnit/externalPortOutput/audioCluster

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortOutput/{stream_idx}/audioCluster/{cluster_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortOutput/{stream_idx}/audioCluster/{cluster_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

        Integer clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AUDIO_CLUSTER result = apiInstance.writeDescAudioUnitExternalPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitExternalPortOutputAudioCluster");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

        Integer clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AUDIO_CLUSTER result = apiInstance.writeDescAudioUnitExternalPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitExternalPortOutputAudioCluster");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
Integer *clusterIdx = 0; // Descriptor AUDIO_CLUSTER index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor audioUnit/externalPortOutput/audioCluster
[apiInstance writeDescAudioUnitExternalPortOutputAudioClusterWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    clusterIdx:clusterIdx
    length:length
    data:data
              completionHandler: ^(AUDIO_CLUSTER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor EXTERNAL_PORT_OUTPUT index

var clusterIdx = 0; // {Integer} Descriptor AUDIO_CLUSTER index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescAudioUnitExternalPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescAudioUnitExternalPortOutputAudioClusterExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
            var clusterIdx = 0;  // Integer | Descriptor AUDIO_CLUSTER index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor audioUnit/externalPortOutput/audioCluster
                AUDIO_CLUSTER result = apiInstance.writeDescAudioUnitExternalPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.writeDescAudioUnitExternalPortOutputAudioCluster: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

$clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescAudioUnitExternalPortOutputAudioCluster($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $clusterIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->writeDescAudioUnitExternalPortOutputAudioCluster: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor EXTERNAL_PORT_OUTPUT index

my $clusterIdx = 0; # Integer | Descriptor AUDIO_CLUSTER index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescAudioUnitExternalPortOutputAudioCluster(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, clusterIdx => $clusterIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->writeDescAudioUnitExternalPortOutputAudioCluster: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
clusterIdx = 0 # Integer | Descriptor AUDIO_CLUSTER index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor audioUnit/externalPortOutput/audioCluster
    api_response = api_instance.write_desc_audio_unit_external_port_output_audio_cluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->writeDescAudioUnitExternalPortOutputAudioCluster: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let clusterIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = AudioUnitApi::Context::default();
    let result = client.writeDescAudioUnitExternalPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor EXTERNAL_PORT_OUTPUT index
Required
cluster_idx*
Integer
Descriptor AUDIO_CLUSTER index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


writeDescAudioUnitExternalPortOutputAudioMap

Write Descriptor audioUnit/externalPortOutput/audioMap

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortOutput/{stream_idx}/audioMap/{map_index}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortOutput/{stream_idx}/audioMap/{map_index}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

        Integer mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AUDIO_MAP result = apiInstance.writeDescAudioUnitExternalPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitExternalPortOutputAudioMap");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

        Integer mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AUDIO_MAP result = apiInstance.writeDescAudioUnitExternalPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitExternalPortOutputAudioMap");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
Integer *mapIndex = 0; // Descriptor AUDIO_MAP index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor audioUnit/externalPortOutput/audioMap
[apiInstance writeDescAudioUnitExternalPortOutputAudioMapWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    mapIndex:mapIndex
    length:length
    data:data
              completionHandler: ^(AUDIO_MAP output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor EXTERNAL_PORT_OUTPUT index

var mapIndex = 0; // {Integer} Descriptor AUDIO_MAP index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescAudioUnitExternalPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescAudioUnitExternalPortOutputAudioMapExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
            var mapIndex = 0;  // Integer | Descriptor AUDIO_MAP index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor audioUnit/externalPortOutput/audioMap
                AUDIO_MAP result = apiInstance.writeDescAudioUnitExternalPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.writeDescAudioUnitExternalPortOutputAudioMap: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

$mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescAudioUnitExternalPortOutputAudioMap($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $mapIndex, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->writeDescAudioUnitExternalPortOutputAudioMap: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor EXTERNAL_PORT_OUTPUT index

my $mapIndex = 0; # Integer | Descriptor AUDIO_MAP index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescAudioUnitExternalPortOutputAudioMap(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, mapIndex => $mapIndex, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->writeDescAudioUnitExternalPortOutputAudioMap: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
mapIndex = 0 # Integer | Descriptor AUDIO_MAP index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor audioUnit/externalPortOutput/audioMap
    api_response = api_instance.write_desc_audio_unit_external_port_output_audio_map(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->writeDescAudioUnitExternalPortOutputAudioMap: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let mapIndex = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = AudioUnitApi::Context::default();
    let result = client.writeDescAudioUnitExternalPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor EXTERNAL_PORT_OUTPUT index
Required
map_index*
Integer
Descriptor AUDIO_MAP index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


writeDescAudioUnitExternalPortOutputControl

Write Descriptor audioUnit/externalPortOutput/control

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortOutput/{stream_idx}/control/{control_index}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/externalPortOutput/{stream_idx}/control/{control_index}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            CONTROL result = apiInstance.writeDescAudioUnitExternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitExternalPortOutputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            CONTROL result = apiInstance.writeDescAudioUnitExternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitExternalPortOutputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor audioUnit/externalPortOutput/control
[apiInstance writeDescAudioUnitExternalPortOutputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    length:length
    data:data
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor EXTERNAL_PORT_OUTPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescAudioUnitExternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescAudioUnitExternalPortOutputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor audioUnit/externalPortOutput/control
                CONTROL result = apiInstance.writeDescAudioUnitExternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.writeDescAudioUnitExternalPortOutputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor EXTERNAL_PORT_OUTPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescAudioUnitExternalPortOutputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->writeDescAudioUnitExternalPortOutputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor EXTERNAL_PORT_OUTPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescAudioUnitExternalPortOutputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->writeDescAudioUnitExternalPortOutputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor EXTERNAL_PORT_OUTPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor audioUnit/externalPortOutput/control
    api_response = api_instance.write_desc_audio_unit_external_port_output_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->writeDescAudioUnitExternalPortOutputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = AudioUnitApi::Context::default();
    let result = client.writeDescAudioUnitExternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor EXTERNAL_PORT_OUTPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


writeDescAudioUnitInternalPortInput

Write Descriptor audioUnit/internalPortInput

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortInput/{stream_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortInput/{stream_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            INTERNAL_PORT_INPUT result = apiInstance.writeDescAudioUnitInternalPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitInternalPortInput");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            INTERNAL_PORT_INPUT result = apiInstance.writeDescAudioUnitInternalPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitInternalPortInput");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor INTERNAL_PORT_INPUT index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor audioUnit/internalPortInput
[apiInstance writeDescAudioUnitInternalPortInputWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    length:length
    data:data
              completionHandler: ^(INTERNAL_PORT_INPUT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor INTERNAL_PORT_INPUT index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescAudioUnitInternalPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescAudioUnitInternalPortInputExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor INTERNAL_PORT_INPUT index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor audioUnit/internalPortInput
                INTERNAL_PORT_INPUT result = apiInstance.writeDescAudioUnitInternalPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.writeDescAudioUnitInternalPortInput: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescAudioUnitInternalPortInput($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->writeDescAudioUnitInternalPortInput: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor INTERNAL_PORT_INPUT index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescAudioUnitInternalPortInput(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->writeDescAudioUnitInternalPortInput: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor INTERNAL_PORT_INPUT index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor audioUnit/internalPortInput
    api_response = api_instance.write_desc_audio_unit_internal_port_input(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->writeDescAudioUnitInternalPortInput: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = AudioUnitApi::Context::default();
    let result = client.writeDescAudioUnitInternalPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor INTERNAL_PORT_INPUT index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


writeDescAudioUnitInternalPortInputAudioCluster

Write Descriptor audioUnit/internalPortInput/audioCluster

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortInput/{stream_idx}/audioCluster/{cluster_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortInput/{stream_idx}/audioCluster/{cluster_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

        Integer clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AUDIO_CLUSTER result = apiInstance.writeDescAudioUnitInternalPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitInternalPortInputAudioCluster");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

        Integer clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AUDIO_CLUSTER result = apiInstance.writeDescAudioUnitInternalPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitInternalPortInputAudioCluster");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor INTERNAL_PORT_INPUT index
 (default to null)
Integer *clusterIdx = 0; // Descriptor AUDIO_CLUSTER index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor audioUnit/internalPortInput/audioCluster
[apiInstance writeDescAudioUnitInternalPortInputAudioClusterWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    clusterIdx:clusterIdx
    length:length
    data:data
              completionHandler: ^(AUDIO_CLUSTER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor INTERNAL_PORT_INPUT index

var clusterIdx = 0; // {Integer} Descriptor AUDIO_CLUSTER index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescAudioUnitInternalPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescAudioUnitInternalPortInputAudioClusterExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor INTERNAL_PORT_INPUT index
 (default to null)
            var clusterIdx = 0;  // Integer | Descriptor AUDIO_CLUSTER index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor audioUnit/internalPortInput/audioCluster
                AUDIO_CLUSTER result = apiInstance.writeDescAudioUnitInternalPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.writeDescAudioUnitInternalPortInputAudioCluster: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

$clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescAudioUnitInternalPortInputAudioCluster($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $clusterIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->writeDescAudioUnitInternalPortInputAudioCluster: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor INTERNAL_PORT_INPUT index

my $clusterIdx = 0; # Integer | Descriptor AUDIO_CLUSTER index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescAudioUnitInternalPortInputAudioCluster(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, clusterIdx => $clusterIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->writeDescAudioUnitInternalPortInputAudioCluster: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor INTERNAL_PORT_INPUT index
 (default to null)
clusterIdx = 0 # Integer | Descriptor AUDIO_CLUSTER index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor audioUnit/internalPortInput/audioCluster
    api_response = api_instance.write_desc_audio_unit_internal_port_input_audio_cluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->writeDescAudioUnitInternalPortInputAudioCluster: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let clusterIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = AudioUnitApi::Context::default();
    let result = client.writeDescAudioUnitInternalPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor INTERNAL_PORT_INPUT index
Required
cluster_idx*
Integer
Descriptor AUDIO_CLUSTER index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


writeDescAudioUnitInternalPortInputAudioMap

Write Descriptor audioUnit/internalPortInput/audioMap

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortInput/{stream_idx}/audioMap/{map_index}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortInput/{stream_idx}/audioMap/{map_index}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

        Integer mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AUDIO_MAP result = apiInstance.writeDescAudioUnitInternalPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitInternalPortInputAudioMap");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

        Integer mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AUDIO_MAP result = apiInstance.writeDescAudioUnitInternalPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitInternalPortInputAudioMap");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor INTERNAL_PORT_INPUT index
 (default to null)
Integer *mapIndex = 0; // Descriptor AUDIO_MAP index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor audioUnit/internalPortInput/audioMap
[apiInstance writeDescAudioUnitInternalPortInputAudioMapWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    mapIndex:mapIndex
    length:length
    data:data
              completionHandler: ^(AUDIO_MAP output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor INTERNAL_PORT_INPUT index

var mapIndex = 0; // {Integer} Descriptor AUDIO_MAP index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescAudioUnitInternalPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescAudioUnitInternalPortInputAudioMapExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor INTERNAL_PORT_INPUT index
 (default to null)
            var mapIndex = 0;  // Integer | Descriptor AUDIO_MAP index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor audioUnit/internalPortInput/audioMap
                AUDIO_MAP result = apiInstance.writeDescAudioUnitInternalPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.writeDescAudioUnitInternalPortInputAudioMap: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

$mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescAudioUnitInternalPortInputAudioMap($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $mapIndex, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->writeDescAudioUnitInternalPortInputAudioMap: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor INTERNAL_PORT_INPUT index

my $mapIndex = 0; # Integer | Descriptor AUDIO_MAP index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescAudioUnitInternalPortInputAudioMap(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, mapIndex => $mapIndex, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->writeDescAudioUnitInternalPortInputAudioMap: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor INTERNAL_PORT_INPUT index
 (default to null)
mapIndex = 0 # Integer | Descriptor AUDIO_MAP index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor audioUnit/internalPortInput/audioMap
    api_response = api_instance.write_desc_audio_unit_internal_port_input_audio_map(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->writeDescAudioUnitInternalPortInputAudioMap: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let mapIndex = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = AudioUnitApi::Context::default();
    let result = client.writeDescAudioUnitInternalPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor INTERNAL_PORT_INPUT index
Required
map_index*
Integer
Descriptor AUDIO_MAP index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


writeDescAudioUnitInternalPortInputControl

Write Descriptor audioUnit/internalPortInput/control

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortInput/{stream_idx}/control/{control_index}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortInput/{stream_idx}/control/{control_index}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            CONTROL result = apiInstance.writeDescAudioUnitInternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitInternalPortInputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            CONTROL result = apiInstance.writeDescAudioUnitInternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitInternalPortInputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor INTERNAL_PORT_INPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor audioUnit/internalPortInput/control
[apiInstance writeDescAudioUnitInternalPortInputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    length:length
    data:data
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor INTERNAL_PORT_INPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescAudioUnitInternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescAudioUnitInternalPortInputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor INTERNAL_PORT_INPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor audioUnit/internalPortInput/control
                CONTROL result = apiInstance.writeDescAudioUnitInternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.writeDescAudioUnitInternalPortInputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_INPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescAudioUnitInternalPortInputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->writeDescAudioUnitInternalPortInputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor INTERNAL_PORT_INPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescAudioUnitInternalPortInputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->writeDescAudioUnitInternalPortInputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor INTERNAL_PORT_INPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor audioUnit/internalPortInput/control
    api_response = api_instance.write_desc_audio_unit_internal_port_input_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->writeDescAudioUnitInternalPortInputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = AudioUnitApi::Context::default();
    let result = client.writeDescAudioUnitInternalPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor INTERNAL_PORT_INPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


writeDescAudioUnitInternalPortOutput

Write Descriptor audioUnit/internalPortOutput

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortOutput/{stream_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortOutput/{stream_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            INTERNAL_PORT_OUTPUT result = apiInstance.writeDescAudioUnitInternalPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitInternalPortOutput");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            INTERNAL_PORT_OUTPUT result = apiInstance.writeDescAudioUnitInternalPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitInternalPortOutput");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor audioUnit/internalPortOutput
[apiInstance writeDescAudioUnitInternalPortOutputWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    length:length
    data:data
              completionHandler: ^(INTERNAL_PORT_OUTPUT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor INTERNAL_PORT_OUTPUT index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescAudioUnitInternalPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescAudioUnitInternalPortOutputExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor audioUnit/internalPortOutput
                INTERNAL_PORT_OUTPUT result = apiInstance.writeDescAudioUnitInternalPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.writeDescAudioUnitInternalPortOutput: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescAudioUnitInternalPortOutput($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->writeDescAudioUnitInternalPortOutput: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor INTERNAL_PORT_OUTPUT index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescAudioUnitInternalPortOutput(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->writeDescAudioUnitInternalPortOutput: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor audioUnit/internalPortOutput
    api_response = api_instance.write_desc_audio_unit_internal_port_output(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->writeDescAudioUnitInternalPortOutput: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = AudioUnitApi::Context::default();
    let result = client.writeDescAudioUnitInternalPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor INTERNAL_PORT_OUTPUT index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


writeDescAudioUnitInternalPortOutputAudioCluster

Write Descriptor audioUnit/internalPortOutput/audioCluster

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortOutput/{stream_idx}/audioCluster/{cluster_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortOutput/{stream_idx}/audioCluster/{cluster_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

        Integer clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AUDIO_CLUSTER result = apiInstance.writeDescAudioUnitInternalPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitInternalPortOutputAudioCluster");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

        Integer clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AUDIO_CLUSTER result = apiInstance.writeDescAudioUnitInternalPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitInternalPortOutputAudioCluster");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
Integer *clusterIdx = 0; // Descriptor AUDIO_CLUSTER index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor audioUnit/internalPortOutput/audioCluster
[apiInstance writeDescAudioUnitInternalPortOutputAudioClusterWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    clusterIdx:clusterIdx
    length:length
    data:data
              completionHandler: ^(AUDIO_CLUSTER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor INTERNAL_PORT_OUTPUT index

var clusterIdx = 0; // {Integer} Descriptor AUDIO_CLUSTER index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescAudioUnitInternalPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescAudioUnitInternalPortOutputAudioClusterExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
            var clusterIdx = 0;  // Integer | Descriptor AUDIO_CLUSTER index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor audioUnit/internalPortOutput/audioCluster
                AUDIO_CLUSTER result = apiInstance.writeDescAudioUnitInternalPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.writeDescAudioUnitInternalPortOutputAudioCluster: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

$clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescAudioUnitInternalPortOutputAudioCluster($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $clusterIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->writeDescAudioUnitInternalPortOutputAudioCluster: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor INTERNAL_PORT_OUTPUT index

my $clusterIdx = 0; # Integer | Descriptor AUDIO_CLUSTER index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescAudioUnitInternalPortOutputAudioCluster(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, clusterIdx => $clusterIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->writeDescAudioUnitInternalPortOutputAudioCluster: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
clusterIdx = 0 # Integer | Descriptor AUDIO_CLUSTER index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor audioUnit/internalPortOutput/audioCluster
    api_response = api_instance.write_desc_audio_unit_internal_port_output_audio_cluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->writeDescAudioUnitInternalPortOutputAudioCluster: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let clusterIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = AudioUnitApi::Context::default();
    let result = client.writeDescAudioUnitInternalPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor INTERNAL_PORT_OUTPUT index
Required
cluster_idx*
Integer
Descriptor AUDIO_CLUSTER index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


writeDescAudioUnitInternalPortOutputAudioMap

Write Descriptor audioUnit/internalPortOutput/audioMap

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/internalPortOutput/{stream_idx}/audioMap/{map_index}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/internalPortOutput/{stream_idx}/audioMap/{map_index}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

        Integer mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AUDIO_MAP result = apiInstance.writeDescAudioUnitInternalPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitInternalPortOutputAudioMap");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

        Integer mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AUDIO_MAP result = apiInstance.writeDescAudioUnitInternalPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitInternalPortOutputAudioMap");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
Integer *mapIndex = 0; // Descriptor AUDIO_MAP index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor audioUnit/internalPortOutput/audioMap
[apiInstance writeDescAudioUnitInternalPortOutputAudioMapWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    mapIndex:mapIndex
    length:length
    data:data
              completionHandler: ^(AUDIO_MAP output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor INTERNAL_PORT_OUTPUT index

var mapIndex = 0; // {Integer} Descriptor AUDIO_MAP index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescAudioUnitInternalPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescAudioUnitInternalPortOutputAudioMapExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
            var mapIndex = 0;  // Integer | Descriptor AUDIO_MAP index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor audioUnit/internalPortOutput/audioMap
                AUDIO_MAP result = apiInstance.writeDescAudioUnitInternalPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.writeDescAudioUnitInternalPortOutputAudioMap: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

$mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescAudioUnitInternalPortOutputAudioMap($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $mapIndex, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->writeDescAudioUnitInternalPortOutputAudioMap: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor INTERNAL_PORT_OUTPUT index

my $mapIndex = 0; # Integer | Descriptor AUDIO_MAP index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescAudioUnitInternalPortOutputAudioMap(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, mapIndex => $mapIndex, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->writeDescAudioUnitInternalPortOutputAudioMap: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
mapIndex = 0 # Integer | Descriptor AUDIO_MAP index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor audioUnit/internalPortOutput/audioMap
    api_response = api_instance.write_desc_audio_unit_internal_port_output_audio_map(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->writeDescAudioUnitInternalPortOutputAudioMap: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let mapIndex = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = AudioUnitApi::Context::default();
    let result = client.writeDescAudioUnitInternalPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor INTERNAL_PORT_OUTPUT index
Required
map_index*
Integer
Descriptor AUDIO_MAP index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


writeDescAudioUnitInternalPortOutputControl

Write Descriptor audioUnit/internalPortOutput/control

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortOutput/{stream_idx}/control/{control_index}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/internalPortOutput/{stream_idx}/control/{control_index}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            CONTROL result = apiInstance.writeDescAudioUnitInternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitInternalPortOutputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            CONTROL result = apiInstance.writeDescAudioUnitInternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitInternalPortOutputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor audioUnit/internalPortOutput/control
[apiInstance writeDescAudioUnitInternalPortOutputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    length:length
    data:data
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor INTERNAL_PORT_OUTPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescAudioUnitInternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescAudioUnitInternalPortOutputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor audioUnit/internalPortOutput/control
                CONTROL result = apiInstance.writeDescAudioUnitInternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.writeDescAudioUnitInternalPortOutputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor INTERNAL_PORT_OUTPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescAudioUnitInternalPortOutputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->writeDescAudioUnitInternalPortOutputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor INTERNAL_PORT_OUTPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescAudioUnitInternalPortOutputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->writeDescAudioUnitInternalPortOutputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor INTERNAL_PORT_OUTPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor audioUnit/internalPortOutput/control
    api_response = api_instance.write_desc_audio_unit_internal_port_output_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->writeDescAudioUnitInternalPortOutputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = AudioUnitApi::Context::default();
    let result = client.writeDescAudioUnitInternalPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor INTERNAL_PORT_OUTPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


writeDescAudioUnitStreamPortInput

Write audioUnit/streamPortInput

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/streamPortInput/{stream_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/streamPortInput/{stream_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            STREAM_PORT_INPUT result = apiInstance.writeDescAudioUnitStreamPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitStreamPortInput");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            STREAM_PORT_INPUT result = apiInstance.writeDescAudioUnitStreamPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitStreamPortInput");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor STREAM_PORT_INPUT index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write audioUnit/streamPortInput
[apiInstance writeDescAudioUnitStreamPortInputWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    length:length
    data:data
              completionHandler: ^(STREAM_PORT_INPUT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor STREAM_PORT_INPUT index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescAudioUnitStreamPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescAudioUnitStreamPortInputExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor STREAM_PORT_INPUT index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write audioUnit/streamPortInput
                STREAM_PORT_INPUT result = apiInstance.writeDescAudioUnitStreamPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.writeDescAudioUnitStreamPortInput: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescAudioUnitStreamPortInput($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->writeDescAudioUnitStreamPortInput: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor STREAM_PORT_INPUT index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescAudioUnitStreamPortInput(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->writeDescAudioUnitStreamPortInput: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor STREAM_PORT_INPUT index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write audioUnit/streamPortInput
    api_response = api_instance.write_desc_audio_unit_stream_port_input(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->writeDescAudioUnitStreamPortInput: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = AudioUnitApi::Context::default();
    let result = client.writeDescAudioUnitStreamPortInput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor STREAM_PORT_INPUT index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


writeDescAudioUnitStreamPortInputAudioCluster

Write Descriptor audioUnit/streamPortInput/audioCluster

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortInput/{stream_idx}/audioCluster/{cluster_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortInput/{stream_idx}/audioCluster/{cluster_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

        Integer clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AUDIO_CLUSTER result = apiInstance.writeDescAudioUnitStreamPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitStreamPortInputAudioCluster");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

        Integer clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AUDIO_CLUSTER result = apiInstance.writeDescAudioUnitStreamPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitStreamPortInputAudioCluster");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor STREAM_PORT_INPUT index
 (default to null)
Integer *clusterIdx = 0; // Descriptor AUDIO_CLUSTER index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor audioUnit/streamPortInput/audioCluster
[apiInstance writeDescAudioUnitStreamPortInputAudioClusterWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    clusterIdx:clusterIdx
    length:length
    data:data
              completionHandler: ^(AUDIO_CLUSTER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor STREAM_PORT_INPUT index

var clusterIdx = 0; // {Integer} Descriptor AUDIO_CLUSTER index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescAudioUnitStreamPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescAudioUnitStreamPortInputAudioClusterExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor STREAM_PORT_INPUT index
 (default to null)
            var clusterIdx = 0;  // Integer | Descriptor AUDIO_CLUSTER index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor audioUnit/streamPortInput/audioCluster
                AUDIO_CLUSTER result = apiInstance.writeDescAudioUnitStreamPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.writeDescAudioUnitStreamPortInputAudioCluster: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

$clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescAudioUnitStreamPortInputAudioCluster($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $clusterIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->writeDescAudioUnitStreamPortInputAudioCluster: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor STREAM_PORT_INPUT index

my $clusterIdx = 0; # Integer | Descriptor AUDIO_CLUSTER index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescAudioUnitStreamPortInputAudioCluster(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, clusterIdx => $clusterIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->writeDescAudioUnitStreamPortInputAudioCluster: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor STREAM_PORT_INPUT index
 (default to null)
clusterIdx = 0 # Integer | Descriptor AUDIO_CLUSTER index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor audioUnit/streamPortInput/audioCluster
    api_response = api_instance.write_desc_audio_unit_stream_port_input_audio_cluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->writeDescAudioUnitStreamPortInputAudioCluster: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let clusterIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = AudioUnitApi::Context::default();
    let result = client.writeDescAudioUnitStreamPortInputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor STREAM_PORT_INPUT index
Required
cluster_idx*
Integer
Descriptor AUDIO_CLUSTER index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


writeDescAudioUnitStreamPortInputAudioMap

Write Descriptor audioUnit/streamPortInput/audioMap

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortInput/{stream_idx}/audioMap/{map_index}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortInput/{stream_idx}/audioMap/{map_index}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

        Integer mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AUDIO_MAP result = apiInstance.writeDescAudioUnitStreamPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitStreamPortInputAudioMap");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

        Integer mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AUDIO_MAP result = apiInstance.writeDescAudioUnitStreamPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitStreamPortInputAudioMap");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor STREAM_PORT_INPUT index
 (default to null)
Integer *mapIndex = 0; // Descriptor AUDIO_MAP index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor  audioUnit/streamPortInput/audioMap
[apiInstance writeDescAudioUnitStreamPortInputAudioMapWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    mapIndex:mapIndex
    length:length
    data:data
              completionHandler: ^(AUDIO_MAP output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor STREAM_PORT_INPUT index

var mapIndex = 0; // {Integer} Descriptor AUDIO_MAP index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescAudioUnitStreamPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescAudioUnitStreamPortInputAudioMapExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor STREAM_PORT_INPUT index
 (default to null)
            var mapIndex = 0;  // Integer | Descriptor AUDIO_MAP index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor  audioUnit/streamPortInput/audioMap
                AUDIO_MAP result = apiInstance.writeDescAudioUnitStreamPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.writeDescAudioUnitStreamPortInputAudioMap: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

$mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescAudioUnitStreamPortInputAudioMap($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $mapIndex, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->writeDescAudioUnitStreamPortInputAudioMap: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor STREAM_PORT_INPUT index

my $mapIndex = 0; # Integer | Descriptor AUDIO_MAP index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescAudioUnitStreamPortInputAudioMap(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, mapIndex => $mapIndex, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->writeDescAudioUnitStreamPortInputAudioMap: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor STREAM_PORT_INPUT index
 (default to null)
mapIndex = 0 # Integer | Descriptor AUDIO_MAP index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor  audioUnit/streamPortInput/audioMap
    api_response = api_instance.write_desc_audio_unit_stream_port_input_audio_map(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->writeDescAudioUnitStreamPortInputAudioMap: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let mapIndex = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = AudioUnitApi::Context::default();
    let result = client.writeDescAudioUnitStreamPortInputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor STREAM_PORT_INPUT index
Required
map_index*
Integer
Descriptor AUDIO_MAP index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


writeDescAudioUnitStreamPortInputControl

Write Descriptor audioUnit/streamPortInput/control

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortInput/{stream_idx}/control/{control_index}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortInput/{stream_idx}/control/{control_index}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            CONTROL result = apiInstance.writeDescAudioUnitStreamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitStreamPortInputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            CONTROL result = apiInstance.writeDescAudioUnitStreamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitStreamPortInputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor STREAM_PORT_INPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor audioUnit/streamPortInput/control
[apiInstance writeDescAudioUnitStreamPortInputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    length:length
    data:data
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor STREAM_PORT_INPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescAudioUnitStreamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescAudioUnitStreamPortInputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor STREAM_PORT_INPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor audioUnit/streamPortInput/control
                CONTROL result = apiInstance.writeDescAudioUnitStreamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.writeDescAudioUnitStreamPortInputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescAudioUnitStreamPortInputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->writeDescAudioUnitStreamPortInputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor STREAM_PORT_INPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescAudioUnitStreamPortInputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->writeDescAudioUnitStreamPortInputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor STREAM_PORT_INPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor audioUnit/streamPortInput/control
    api_response = api_instance.write_desc_audio_unit_stream_port_input_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->writeDescAudioUnitStreamPortInputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = AudioUnitApi::Context::default();
    let result = client.writeDescAudioUnitStreamPortInputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor STREAM_PORT_INPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


writeDescAudioUnitStreamPortOutput

Write Descriptor audioUnit/streamPortOutput

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortOutput/{stream_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortOutput/{stream_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            STREAM_PORT_OUTPUT result = apiInstance.writeDescAudioUnitStreamPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitStreamPortOutput");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            STREAM_PORT_OUTPUT result = apiInstance.writeDescAudioUnitStreamPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitStreamPortOutput");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor STREAM_PORT_INPUT index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor audioUnit/streamPortOutput
[apiInstance writeDescAudioUnitStreamPortOutputWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    length:length
    data:data
              completionHandler: ^(STREAM_PORT_OUTPUT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor STREAM_PORT_INPUT index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescAudioUnitStreamPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescAudioUnitStreamPortOutputExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor STREAM_PORT_INPUT index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor audioUnit/streamPortOutput
                STREAM_PORT_OUTPUT result = apiInstance.writeDescAudioUnitStreamPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.writeDescAudioUnitStreamPortOutput: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor STREAM_PORT_INPUT index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescAudioUnitStreamPortOutput($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->writeDescAudioUnitStreamPortOutput: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor STREAM_PORT_INPUT index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescAudioUnitStreamPortOutput(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->writeDescAudioUnitStreamPortOutput: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor STREAM_PORT_INPUT index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor audioUnit/streamPortOutput
    api_response = api_instance.write_desc_audio_unit_stream_port_output(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->writeDescAudioUnitStreamPortOutput: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = AudioUnitApi::Context::default();
    let result = client.writeDescAudioUnitStreamPortOutput(deviceId, cfgIdx, audioUnitIdx, streamIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor STREAM_PORT_INPUT index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


writeDescAudioUnitStreamPortOutputAudioCluster

Write Descriptor audioUnit/streamPortOutput/audioCluster

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortOutput/{stream_idx}/audioCluster/{cluster_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortOutput/{stream_idx}/audioCluster/{cluster_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

        Integer clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AUDIO_CLUSTER result = apiInstance.writeDescAudioUnitStreamPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitStreamPortOutputAudioCluster");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

        Integer clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AUDIO_CLUSTER result = apiInstance.writeDescAudioUnitStreamPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitStreamPortOutputAudioCluster");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor STREAM_PORT_OUTPUT index
 (default to null)
Integer *clusterIdx = 0; // Descriptor AUDIO_CLUSTER index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor  audioUnit/streamPortOutput/audioCluster
[apiInstance writeDescAudioUnitStreamPortOutputAudioClusterWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    clusterIdx:clusterIdx
    length:length
    data:data
              completionHandler: ^(AUDIO_CLUSTER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor STREAM_PORT_OUTPUT index

var clusterIdx = 0; // {Integer} Descriptor AUDIO_CLUSTER index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescAudioUnitStreamPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescAudioUnitStreamPortOutputAudioClusterExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor STREAM_PORT_OUTPUT index
 (default to null)
            var clusterIdx = 0;  // Integer | Descriptor AUDIO_CLUSTER index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor  audioUnit/streamPortOutput/audioCluster
                AUDIO_CLUSTER result = apiInstance.writeDescAudioUnitStreamPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.writeDescAudioUnitStreamPortOutputAudioCluster: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

$clusterIdx = 0; // Integer | Descriptor AUDIO_CLUSTER index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescAudioUnitStreamPortOutputAudioCluster($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $clusterIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->writeDescAudioUnitStreamPortOutputAudioCluster: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor STREAM_PORT_OUTPUT index

my $clusterIdx = 0; # Integer | Descriptor AUDIO_CLUSTER index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescAudioUnitStreamPortOutputAudioCluster(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, clusterIdx => $clusterIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->writeDescAudioUnitStreamPortOutputAudioCluster: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor STREAM_PORT_OUTPUT index
 (default to null)
clusterIdx = 0 # Integer | Descriptor AUDIO_CLUSTER index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor  audioUnit/streamPortOutput/audioCluster
    api_response = api_instance.write_desc_audio_unit_stream_port_output_audio_cluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->writeDescAudioUnitStreamPortOutputAudioCluster: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let clusterIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = AudioUnitApi::Context::default();
    let result = client.writeDescAudioUnitStreamPortOutputAudioCluster(deviceId, cfgIdx, audioUnitIdx, streamIdx, clusterIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor STREAM_PORT_OUTPUT index
Required
cluster_idx*
Integer
Descriptor AUDIO_CLUSTER index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


writeDescAudioUnitStreamPortOutputAudioMap

Write Descriptor audioUnitStreamPortOutput/audioMap

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortOutput/{stream_idx}/audioMap/{map_index}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortOutput/{stream_idx}/audioMap/{map_index}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

        Integer mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AUDIO_MAP result = apiInstance.writeDescAudioUnitStreamPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitStreamPortOutputAudioMap");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

        Integer mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AUDIO_MAP result = apiInstance.writeDescAudioUnitStreamPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitStreamPortOutputAudioMap");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor STREAM_PORT_OUTPUT index
 (default to null)
Integer *mapIndex = 0; // Descriptor AUDIO_MAP index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor audioUnitStreamPortOutput/audioMap
[apiInstance writeDescAudioUnitStreamPortOutputAudioMapWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    mapIndex:mapIndex
    length:length
    data:data
              completionHandler: ^(AUDIO_MAP output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor STREAM_PORT_OUTPUT index

var mapIndex = 0; // {Integer} Descriptor AUDIO_MAP index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescAudioUnitStreamPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescAudioUnitStreamPortOutputAudioMapExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor STREAM_PORT_OUTPUT index
 (default to null)
            var mapIndex = 0;  // Integer | Descriptor AUDIO_MAP index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor audioUnitStreamPortOutput/audioMap
                AUDIO_MAP result = apiInstance.writeDescAudioUnitStreamPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.writeDescAudioUnitStreamPortOutputAudioMap: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

$mapIndex = 0; // Integer | Descriptor AUDIO_MAP index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescAudioUnitStreamPortOutputAudioMap($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $mapIndex, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->writeDescAudioUnitStreamPortOutputAudioMap: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor STREAM_PORT_OUTPUT index

my $mapIndex = 0; # Integer | Descriptor AUDIO_MAP index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescAudioUnitStreamPortOutputAudioMap(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, mapIndex => $mapIndex, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->writeDescAudioUnitStreamPortOutputAudioMap: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor STREAM_PORT_OUTPUT index
 (default to null)
mapIndex = 0 # Integer | Descriptor AUDIO_MAP index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor audioUnitStreamPortOutput/audioMap
    api_response = api_instance.write_desc_audio_unit_stream_port_output_audio_map(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->writeDescAudioUnitStreamPortOutputAudioMap: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let mapIndex = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = AudioUnitApi::Context::default();
    let result = client.writeDescAudioUnitStreamPortOutputAudioMap(deviceId, cfgIdx, audioUnitIdx, streamIdx, mapIndex, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor STREAM_PORT_OUTPUT index
Required
map_index*
Integer
Descriptor AUDIO_MAP index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


writeDescAudioUnitStreamPortOutputControl

Write Descriptor audioUnit/streamPortOutput/control

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortOutput/{stream_idx}/control/{control_index}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/entity/configuration/audioUnit/{audioUnit_idx}/streamPortOutput/{stream_idx}/control/{control_index}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AudioUnitApi;

import java.io.File;
import java.util.*;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            CONTROL result = apiInstance.writeDescAudioUnitStreamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitStreamPortOutputControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AudioUnitApi;

public class AudioUnitApiExample {
    public static void main(String[] args) {
        AudioUnitApi apiInstance = new AudioUnitApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

        Integer controlIndex = 0; // Integer | Descriptor CONTROL index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            CONTROL result = apiInstance.writeDescAudioUnitStreamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioUnitApi#writeDescAudioUnitStreamPortOutputControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AudioUnitApi *apiInstance = [[AudioUnitApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *streamIdx = 0; // Descriptor STREAM_PORT_OUTPUT index
 (default to null)
Integer *controlIndex = 0; // Descriptor CONTROL index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor audioUnit/streamPortOutput/control
[apiInstance writeDescAudioUnitStreamPortOutputControlWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    streamIdx:streamIdx
    controlIndex:controlIndex
    length:length
    data:data
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AudioUnitApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var streamIdx = 0; // {Integer} Descriptor STREAM_PORT_OUTPUT index

var controlIndex = 0; // {Integer} Descriptor CONTROL index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescAudioUnitStreamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescAudioUnitStreamPortOutputControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AudioUnitApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var streamIdx = 0;  // Integer | Descriptor STREAM_PORT_OUTPUT index
 (default to null)
            var controlIndex = 0;  // Integer | Descriptor CONTROL index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor audioUnit/streamPortOutput/control
                CONTROL result = apiInstance.writeDescAudioUnitStreamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AudioUnitApi.writeDescAudioUnitStreamPortOutputControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AudioUnitApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$streamIdx = 0; // Integer | Descriptor STREAM_PORT_OUTPUT index

$controlIndex = 0; // Integer | Descriptor CONTROL index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescAudioUnitStreamPortOutputControl($deviceId, $cfgIdx, $audioUnitIdx, $streamIdx, $controlIndex, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioUnitApi->writeDescAudioUnitStreamPortOutputControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AudioUnitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AudioUnitApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $streamIdx = 0; # Integer | Descriptor STREAM_PORT_OUTPUT index

my $controlIndex = 0; # Integer | Descriptor CONTROL index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescAudioUnitStreamPortOutputControl(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, streamIdx => $streamIdx, controlIndex => $controlIndex, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AudioUnitApi->writeDescAudioUnitStreamPortOutputControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AudioUnitApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
streamIdx = 0 # Integer | Descriptor STREAM_PORT_OUTPUT index
 (default to null)
controlIndex = 0 # Integer | Descriptor CONTROL index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor audioUnit/streamPortOutput/control
    api_response = api_instance.write_desc_audio_unit_stream_port_output_control(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AudioUnitApi->writeDescAudioUnitStreamPortOutputControl: %s\n" % e)
extern crate AudioUnitApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let controlIndex = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = AudioUnitApi::Context::default();
    let result = client.writeDescAudioUnitStreamPortOutputControl(deviceId, cfgIdx, audioUnitIdx, streamIdx, controlIndex, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
stream_idx*
Integer
Descriptor STREAM_PORT_OUTPUT index
Required
control_index*
Integer
Descriptor CONTROL index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


AvbInterface

getAvbInterfaceAsPath

Get as-path informations from AVB Interface.

The **GET_AS_PATH** command is used to get the pathSequence from the PathTrace TLV of the Announce message in *IEEE Std 802.1AS-2011*


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/avbInterface/{interface_idx}/asPath

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/avbInterface/{interface_idx}/asPath"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AvbInterfaceApi;

import java.io.File;
import java.util.*;

public class AvbInterfaceApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AvbInterfaceApi apiInstance = new AvbInterfaceApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer interfaceIdx = 0; // Integer | Valid top level descriptor index

        
        try {
            inline_response_200_15 result = apiInstance.getAvbInterfaceAsPath(deviceId, cfgIdx, interfaceIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvbInterfaceApi#getAvbInterfaceAsPath");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AvbInterfaceApi;

public class AvbInterfaceApiExample {
    public static void main(String[] args) {
        AvbInterfaceApi apiInstance = new AvbInterfaceApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer interfaceIdx = 0; // Integer | Valid top level descriptor index

        
        try {
            inline_response_200_15 result = apiInstance.getAvbInterfaceAsPath(deviceId, cfgIdx, interfaceIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvbInterfaceApi#getAvbInterfaceAsPath");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AvbInterfaceApi *apiInstance = [[AvbInterfaceApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *interfaceIdx = 0; // Valid top level descriptor index
 (default to null)

// Get as-path informations from AVB Interface.
[apiInstance getAvbInterfaceAsPathWith:deviceId
    cfgIdx:cfgIdx
    interfaceIdx:interfaceIdx
              completionHandler: ^(inline_response_200_15 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AvbInterfaceApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var interfaceIdx = 0; // {Integer} Valid top level descriptor index


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAvbInterfaceAsPath(deviceId, cfgIdx, interfaceIdx, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAvbInterfaceAsPathExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AvbInterfaceApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var interfaceIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)

            try {
                // Get as-path informations from AVB Interface.
                inline_response_200_15 result = apiInstance.getAvbInterfaceAsPath(deviceId, cfgIdx, interfaceIdx);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvbInterfaceApi.getAvbInterfaceAsPath: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvbInterfaceApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$interfaceIdx = 0; // Integer | Valid top level descriptor index


try {
    $result = $api_instance->getAvbInterfaceAsPath($deviceId, $cfgIdx, $interfaceIdx);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvbInterfaceApi->getAvbInterfaceAsPath: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AvbInterfaceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AvbInterfaceApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $interfaceIdx = 0; # Integer | Valid top level descriptor index


eval { 
    my $result = $api_instance->getAvbInterfaceAsPath(deviceId => $deviceId, cfgIdx => $cfgIdx, interfaceIdx => $interfaceIdx);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvbInterfaceApi->getAvbInterfaceAsPath: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AvbInterfaceApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
interfaceIdx = 0 # Integer | Valid top level descriptor index
 (default to null)

try: 
    # Get as-path informations from AVB Interface.
    api_response = api_instance.get_avb_interface_as_path(deviceId, cfgIdx, interfaceIdx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvbInterfaceApi->getAvbInterfaceAsPath: %s\n" % e)
extern crate AvbInterfaceApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let interfaceIdx = 0; // Integer

    let mut context = AvbInterfaceApi::Context::default();
    let result = client.getAvbInterfaceAsPath(deviceId, cfgIdx, interfaceIdx, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
interface_idx*
Integer
Valid top level descriptor index
Required

Responses


getAvbInterfaceCounters

Get Counters from Descriptor AVB_INTERFACE

The **GET_COUNTERS** command is used to get the performance variables and diagnostics counters. The answer is descriptor specific, see extended documentation.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/avbInterface/{interface_idx}/counter

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/avbInterface/{interface_idx}/counter"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AvbInterfaceApi;

import java.io.File;
import java.util.*;

public class AvbInterfaceApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AvbInterfaceApi apiInstance = new AvbInterfaceApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer interfaceIdx = 0; // Integer | Valid top level descriptor index

        
        try {
            inline_response_200_16 result = apiInstance.getAvbInterfaceCounters(deviceId, cfgIdx, interfaceIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvbInterfaceApi#getAvbInterfaceCounters");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AvbInterfaceApi;

public class AvbInterfaceApiExample {
    public static void main(String[] args) {
        AvbInterfaceApi apiInstance = new AvbInterfaceApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer interfaceIdx = 0; // Integer | Valid top level descriptor index

        
        try {
            inline_response_200_16 result = apiInstance.getAvbInterfaceCounters(deviceId, cfgIdx, interfaceIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvbInterfaceApi#getAvbInterfaceCounters");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AvbInterfaceApi *apiInstance = [[AvbInterfaceApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *interfaceIdx = 0; // Valid top level descriptor index
 (default to null)

// Get Counters from Descriptor AVB_INTERFACE
[apiInstance getAvbInterfaceCountersWith:deviceId
    cfgIdx:cfgIdx
    interfaceIdx:interfaceIdx
              completionHandler: ^(inline_response_200_16 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AvbInterfaceApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var interfaceIdx = 0; // {Integer} Valid top level descriptor index


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAvbInterfaceCounters(deviceId, cfgIdx, interfaceIdx, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAvbInterfaceCountersExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AvbInterfaceApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var interfaceIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)

            try {
                // Get Counters from Descriptor AVB_INTERFACE
                inline_response_200_16 result = apiInstance.getAvbInterfaceCounters(deviceId, cfgIdx, interfaceIdx);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvbInterfaceApi.getAvbInterfaceCounters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvbInterfaceApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$interfaceIdx = 0; // Integer | Valid top level descriptor index


try {
    $result = $api_instance->getAvbInterfaceCounters($deviceId, $cfgIdx, $interfaceIdx);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvbInterfaceApi->getAvbInterfaceCounters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AvbInterfaceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AvbInterfaceApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $interfaceIdx = 0; # Integer | Valid top level descriptor index


eval { 
    my $result = $api_instance->getAvbInterfaceCounters(deviceId => $deviceId, cfgIdx => $cfgIdx, interfaceIdx => $interfaceIdx);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvbInterfaceApi->getAvbInterfaceCounters: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AvbInterfaceApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
interfaceIdx = 0 # Integer | Valid top level descriptor index
 (default to null)

try: 
    # Get Counters from Descriptor AVB_INTERFACE
    api_response = api_instance.get_avb_interface_counters(deviceId, cfgIdx, interfaceIdx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvbInterfaceApi->getAvbInterfaceCounters: %s\n" % e)
extern crate AvbInterfaceApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let interfaceIdx = 0; // Integer

    let mut context = AvbInterfaceApi::Context::default();
    let result = client.getAvbInterfaceCounters(deviceId, cfgIdx, interfaceIdx, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
interface_idx*
Integer
Valid top level descriptor index
Required

Responses


getAvbInterfaceInfo

Get Interface Infos per GET_AVB_INTERFACE or GET_MILAN_INFO

The **GET_AVB_INFO** command is used to get the dynamic AVB information for an AVB_INTERFACE in the current Configuration. The **GET_MILAN_INFO** command is used to get the dynamic MILAN information for an AVB_INTERFACE in the current Configuration.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/avbInterface/{interface_idx}/info

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/avbInterface/{interface_idx}/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AvbInterfaceApi;

import java.io.File;
import java.util.*;

public class AvbInterfaceApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AvbInterfaceApi apiInstance = new AvbInterfaceApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer interfaceIdx = 0; // Integer | Valid top level descriptor index

        
        try {
            oneOf result = apiInstance.getAvbInterfaceInfo(deviceId, cfgIdx, interfaceIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvbInterfaceApi#getAvbInterfaceInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AvbInterfaceApi;

public class AvbInterfaceApiExample {
    public static void main(String[] args) {
        AvbInterfaceApi apiInstance = new AvbInterfaceApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer interfaceIdx = 0; // Integer | Valid top level descriptor index

        
        try {
            oneOf result = apiInstance.getAvbInterfaceInfo(deviceId, cfgIdx, interfaceIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvbInterfaceApi#getAvbInterfaceInfo");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AvbInterfaceApi *apiInstance = [[AvbInterfaceApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *interfaceIdx = 0; // Valid top level descriptor index
 (default to null)

// Get Interface Infos per GET_AVB_INTERFACE or GET_MILAN_INFO
[apiInstance getAvbInterfaceInfoWith:deviceId
    cfgIdx:cfgIdx
    interfaceIdx:interfaceIdx
              completionHandler: ^(oneOf output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AvbInterfaceApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var interfaceIdx = 0; // {Integer} Valid top level descriptor index


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAvbInterfaceInfo(deviceId, cfgIdx, interfaceIdx, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAvbInterfaceInfoExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AvbInterfaceApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var interfaceIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)

            try {
                // Get Interface Infos per GET_AVB_INTERFACE or GET_MILAN_INFO
                oneOf result = apiInstance.getAvbInterfaceInfo(deviceId, cfgIdx, interfaceIdx);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvbInterfaceApi.getAvbInterfaceInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvbInterfaceApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$interfaceIdx = 0; // Integer | Valid top level descriptor index


try {
    $result = $api_instance->getAvbInterfaceInfo($deviceId, $cfgIdx, $interfaceIdx);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvbInterfaceApi->getAvbInterfaceInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AvbInterfaceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AvbInterfaceApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $interfaceIdx = 0; # Integer | Valid top level descriptor index


eval { 
    my $result = $api_instance->getAvbInterfaceInfo(deviceId => $deviceId, cfgIdx => $cfgIdx, interfaceIdx => $interfaceIdx);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvbInterfaceApi->getAvbInterfaceInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AvbInterfaceApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
interfaceIdx = 0 # Integer | Valid top level descriptor index
 (default to null)

try: 
    # Get Interface Infos per GET_AVB_INTERFACE or GET_MILAN_INFO
    api_response = api_instance.get_avb_interface_info(deviceId, cfgIdx, interfaceIdx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvbInterfaceApi->getAvbInterfaceInfo: %s\n" % e)
extern crate AvbInterfaceApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let interfaceIdx = 0; // Integer

    let mut context = AvbInterfaceApi::Context::default();
    let result = client.getAvbInterfaceInfo(deviceId, cfgIdx, interfaceIdx, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
interface_idx*
Integer
Valid top level descriptor index
Required

Responses


getDescAvbInterface

Get avbInterface Descriptor


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/avbInterface/{interface_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/avbInterface/{interface_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AvbInterfaceApi;

import java.io.File;
import java.util.*;

public class AvbInterfaceApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AvbInterfaceApi apiInstance = new AvbInterfaceApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer interfaceIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            AVB_INTERFACE result = apiInstance.getDescAvbInterface(deviceId, cfgIdx, interfaceIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvbInterfaceApi#getDescAvbInterface");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AvbInterfaceApi;

public class AvbInterfaceApiExample {
    public static void main(String[] args) {
        AvbInterfaceApi apiInstance = new AvbInterfaceApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer interfaceIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            AVB_INTERFACE result = apiInstance.getDescAvbInterface(deviceId, cfgIdx, interfaceIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvbInterfaceApi#getDescAvbInterface");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AvbInterfaceApi *apiInstance = [[AvbInterfaceApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *interfaceIdx = 0; // Valid top level descriptor index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

// Get avbInterface Descriptor
[apiInstance getDescAvbInterfaceWith:deviceId
    cfgIdx:cfgIdx
    interfaceIdx:interfaceIdx
    entity:entity
              completionHandler: ^(AVB_INTERFACE output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AvbInterfaceApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var interfaceIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescAvbInterface(deviceId, cfgIdx, interfaceIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescAvbInterfaceExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AvbInterfaceApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var interfaceIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional)  (default to null)

            try {
                // Get avbInterface Descriptor
                AVB_INTERFACE result = apiInstance.getDescAvbInterface(deviceId, cfgIdx, interfaceIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvbInterfaceApi.getDescAvbInterface: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvbInterfaceApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$interfaceIdx = 0; // Integer | Valid top level descriptor index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


try {
    $result = $api_instance->getDescAvbInterface($deviceId, $cfgIdx, $interfaceIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvbInterfaceApi->getDescAvbInterface: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AvbInterfaceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AvbInterfaceApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $interfaceIdx = 0; # Integer | Valid top level descriptor index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


eval { 
    my $result = $api_instance->getDescAvbInterface(deviceId => $deviceId, cfgIdx => $cfgIdx, interfaceIdx => $interfaceIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvbInterfaceApi->getDescAvbInterface: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AvbInterfaceApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
interfaceIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

try: 
    # Get avbInterface Descriptor
    api_response = api_instance.get_desc_avb_interface(deviceId, cfgIdx, interfaceIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvbInterfaceApi->getDescAvbInterface: %s\n" % e)
extern crate AvbInterfaceApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let interfaceIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = AvbInterfaceApi::Context::default();
    let result = client.getDescAvbInterface(deviceId, cfgIdx, interfaceIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
interface_idx*
Integer
Valid top level descriptor index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

Responses


modifyDescAvbInterface

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/avbInterface/{interface_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/avbInterface/{interface_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AvbInterfaceApi;

import java.io.File;
import java.util.*;

public class AvbInterfaceApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AvbInterfaceApi apiInstance = new AvbInterfaceApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 00-50-c2-ff-fe-d4-33-8d; // Integer | valid configurations index

        Integer interfaceIdx = 0; // Integer | Valid top level descriptor index

        AVBINTERFACE1 aVBINTERFACE1 = {AVB_INTERFACE={objectName=Interface 0}}; // AVBINTERFACE1 | 
        
        try {
            AVB_INTERFACE result = apiInstance.modifyDescAvbInterface(deviceId, cfgIdx, interfaceIdx, aVBINTERFACE1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvbInterfaceApi#modifyDescAvbInterface");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AvbInterfaceApi;

public class AvbInterfaceApiExample {
    public static void main(String[] args) {
        AvbInterfaceApi apiInstance = new AvbInterfaceApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 00-50-c2-ff-fe-d4-33-8d; // Integer | valid configurations index

        Integer interfaceIdx = 0; // Integer | Valid top level descriptor index

        AVBINTERFACE1 aVBINTERFACE1 = {AVB_INTERFACE={objectName=Interface 0}}; // AVBINTERFACE1 | 
        
        try {
            AVB_INTERFACE result = apiInstance.modifyDescAvbInterface(deviceId, cfgIdx, interfaceIdx, aVBINTERFACE1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvbInterfaceApi#modifyDescAvbInterface");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AvbInterfaceApi *apiInstance = [[AvbInterfaceApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 00-50-c2-ff-fe-d4-33-8d; // valid configurations index
 (default to null)
Integer *interfaceIdx = 0; // Valid top level descriptor index
 (default to null)
AVBINTERFACE1 *aVBINTERFACE1 = {AVB_INTERFACE={objectName=Interface 0}}; //  (optional)

// modify Descriptor variable Values
[apiInstance modifyDescAvbInterfaceWith:deviceId
    cfgIdx:cfgIdx
    interfaceIdx:interfaceIdx
    aVBINTERFACE1:aVBINTERFACE1
              completionHandler: ^(AVB_INTERFACE output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AvbInterfaceApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 00-50-c2-ff-fe-d4-33-8d; // {Integer} valid configurations index

var interfaceIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'aVBINTERFACE1': {AVB_INTERFACE={objectName=Interface 0}} // {AVBINTERFACE1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyDescAvbInterface(deviceId, cfgIdx, interfaceIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyDescAvbInterfaceExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AvbInterfaceApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 00-50-c2-ff-fe-d4-33-8d;  // Integer | valid configurations index
 (default to null)
            var interfaceIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var aVBINTERFACE1 = new AVBINTERFACE1(); // AVBINTERFACE1 |  (optional) 

            try {
                // modify Descriptor variable Values
                AVB_INTERFACE result = apiInstance.modifyDescAvbInterface(deviceId, cfgIdx, interfaceIdx, aVBINTERFACE1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvbInterfaceApi.modifyDescAvbInterface: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvbInterfaceApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 00-50-c2-ff-fe-d4-33-8d; // Integer | valid configurations index

$interfaceIdx = 0; // Integer | Valid top level descriptor index

$aVBINTERFACE1 = {AVB_INTERFACE={objectName=Interface 0}}; // AVBINTERFACE1 | 

try {
    $result = $api_instance->modifyDescAvbInterface($deviceId, $cfgIdx, $interfaceIdx, $aVBINTERFACE1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvbInterfaceApi->modifyDescAvbInterface: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AvbInterfaceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AvbInterfaceApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 00-50-c2-ff-fe-d4-33-8d; # Integer | valid configurations index

my $interfaceIdx = 0; # Integer | Valid top level descriptor index

my $aVBINTERFACE1 = WWW::OPenAPIClient::Object::AVBINTERFACE1->new(); # AVBINTERFACE1 | 

eval { 
    my $result = $api_instance->modifyDescAvbInterface(deviceId => $deviceId, cfgIdx => $cfgIdx, interfaceIdx => $interfaceIdx, aVBINTERFACE1 => $aVBINTERFACE1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvbInterfaceApi->modifyDescAvbInterface: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AvbInterfaceApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 00-50-c2-ff-fe-d4-33-8d # Integer | valid configurations index
 (default to null)
interfaceIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
aVBINTERFACE1 = {AVB_INTERFACE={objectName=Interface 0}} # AVBINTERFACE1 |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.modify_desc_avb_interface(deviceId, cfgIdx, interfaceIdx, aVBINTERFACE1=aVBINTERFACE1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvbInterfaceApi->modifyDescAvbInterface: %s\n" % e)
extern crate AvbInterfaceApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 00-50-c2-ff-fe-d4-33-8d; // Integer
    let interfaceIdx = 0; // Integer
    let aVBINTERFACE1 = {AVB_INTERFACE={objectName=Interface 0}}; // AVBINTERFACE1

    let mut context = AvbInterfaceApi::Context::default();
    let result = client.modifyDescAvbInterface(deviceId, cfgIdx, interfaceIdx, aVBINTERFACE1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
interface_idx*
Integer
Valid top level descriptor index
Required
Body parameters
Name Description
aVBINTERFACE1

Set Object Name

Responses


writeDescAvbInterface

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/avbInterface/{interface_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/avbInterface/{interface_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AvbInterfaceApi;

import java.io.File;
import java.util.*;

public class AvbInterfaceApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AvbInterfaceApi apiInstance = new AvbInterfaceApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 00-50-c2-ff-fe-d4-33-8d; // Integer | valid configurations index

        Integer interfaceIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AVB_INTERFACE result = apiInstance.writeDescAvbInterface(deviceId, cfgIdx, interfaceIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvbInterfaceApi#writeDescAvbInterface");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AvbInterfaceApi;

public class AvbInterfaceApiExample {
    public static void main(String[] args) {
        AvbInterfaceApi apiInstance = new AvbInterfaceApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 00-50-c2-ff-fe-d4-33-8d; // Integer | valid configurations index

        Integer interfaceIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            AVB_INTERFACE result = apiInstance.writeDescAvbInterface(deviceId, cfgIdx, interfaceIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvbInterfaceApi#writeDescAvbInterface");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AvbInterfaceApi *apiInstance = [[AvbInterfaceApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 00-50-c2-ff-fe-d4-33-8d; // valid configurations index
 (default to null)
Integer *interfaceIdx = 0; // Valid top level descriptor index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance writeDescAvbInterfaceWith:deviceId
    cfgIdx:cfgIdx
    interfaceIdx:interfaceIdx
    length:length
    data:data
              completionHandler: ^(AVB_INTERFACE output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.AvbInterfaceApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 00-50-c2-ff-fe-d4-33-8d; // {Integer} valid configurations index

var interfaceIdx = 0; // {Integer} Valid top level descriptor index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescAvbInterface(deviceId, cfgIdx, interfaceIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescAvbInterfaceExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AvbInterfaceApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 00-50-c2-ff-fe-d4-33-8d;  // Integer | valid configurations index
 (default to null)
            var interfaceIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                AVB_INTERFACE result = apiInstance.writeDescAvbInterface(deviceId, cfgIdx, interfaceIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvbInterfaceApi.writeDescAvbInterface: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvbInterfaceApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 00-50-c2-ff-fe-d4-33-8d; // Integer | valid configurations index

$interfaceIdx = 0; // Integer | Valid top level descriptor index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescAvbInterface($deviceId, $cfgIdx, $interfaceIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvbInterfaceApi->writeDescAvbInterface: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AvbInterfaceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AvbInterfaceApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 00-50-c2-ff-fe-d4-33-8d; # Integer | valid configurations index

my $interfaceIdx = 0; # Integer | Valid top level descriptor index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescAvbInterface(deviceId => $deviceId, cfgIdx => $cfgIdx, interfaceIdx => $interfaceIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvbInterfaceApi->writeDescAvbInterface: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AvbInterfaceApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 00-50-c2-ff-fe-d4-33-8d # Integer | valid configurations index
 (default to null)
interfaceIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.write_desc_avb_interface(deviceId, cfgIdx, interfaceIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvbInterfaceApi->writeDescAvbInterface: %s\n" % e)
extern crate AvbInterfaceApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 00-50-c2-ff-fe-d4-33-8d; // Integer
    let interfaceIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = AvbInterfaceApi::Context::default();
    let result = client.writeDescAvbInterface(deviceId, cfgIdx, interfaceIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
interface_idx*
Integer
Valid top level descriptor index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


Base

getApiEntry

API entry point


/v1.0

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BaseApi;

import java.io.File;
import java.util.*;

public class BaseApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        BaseApi apiInstance = new BaseApi();
        
        try {
            inline_response_200 result = apiInstance.getApiEntry();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BaseApi#getApiEntry");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BaseApi;

public class BaseApiExample {
    public static void main(String[] args) {
        BaseApi apiInstance = new BaseApi();
        
        try {
            inline_response_200 result = apiInstance.getApiEntry();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BaseApi#getApiEntry");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
BaseApi *apiInstance = [[BaseApi alloc] init];

// API entry point
[apiInstance getApiEntryWithCompletionHandler: 
              ^(inline_response_200 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.BaseApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getApiEntry(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getApiEntryExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new BaseApi();

            try {
                // API entry point
                inline_response_200 result = apiInstance.getApiEntry();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BaseApi.getApiEntry: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BaseApi();

try {
    $result = $api_instance->getApiEntry();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BaseApi->getApiEntry: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BaseApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BaseApi->new();

eval { 
    my $result = $api_instance->getApiEntry();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BaseApi->getApiEntry: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.BaseApi()

try: 
    # API entry point
    api_response = api_instance.get_api_entry()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BaseApi->getApiEntry: %s\n" % e)
extern crate BaseApi;

pub fn main() {

    let mut context = BaseApi::Context::default();
    let result = client.getApiEntry(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


ClockDomain

getClockDomainCounters

Get Counters from Descriptor CLOCK_DOMAIN

The **GET_COUNTERS** command is used to get the performance variables and diagnostics counters. The answer is descriptor specific, see extended documentation.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/clockDomain/{domain_idx}/counters

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/clockDomain/{domain_idx}/counters"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClockDomainApi;

import java.io.File;
import java.util.*;

public class ClockDomainApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        ClockDomainApi apiInstance = new ClockDomainApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer domainIdx = 0; // Integer | Valid top level descriptor index

        
        try {
            inline_response_200_22 result = apiInstance.getClockDomainCounters(deviceId, cfgIdx, domainIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClockDomainApi#getClockDomainCounters");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ClockDomainApi;

public class ClockDomainApiExample {
    public static void main(String[] args) {
        ClockDomainApi apiInstance = new ClockDomainApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer domainIdx = 0; // Integer | Valid top level descriptor index

        
        try {
            inline_response_200_22 result = apiInstance.getClockDomainCounters(deviceId, cfgIdx, domainIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClockDomainApi#getClockDomainCounters");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ClockDomainApi *apiInstance = [[ClockDomainApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *domainIdx = 0; // Valid top level descriptor index
 (default to null)

// Get Counters from Descriptor CLOCK_DOMAIN
[apiInstance getClockDomainCountersWith:deviceId
    cfgIdx:cfgIdx
    domainIdx:domainIdx
              completionHandler: ^(inline_response_200_22 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.ClockDomainApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var domainIdx = 0; // {Integer} Valid top level descriptor index


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getClockDomainCounters(deviceId, cfgIdx, domainIdx, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getClockDomainCountersExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new ClockDomainApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var domainIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)

            try {
                // Get Counters from Descriptor CLOCK_DOMAIN
                inline_response_200_22 result = apiInstance.getClockDomainCounters(deviceId, cfgIdx, domainIdx);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ClockDomainApi.getClockDomainCounters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ClockDomainApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$domainIdx = 0; // Integer | Valid top level descriptor index


try {
    $result = $api_instance->getClockDomainCounters($deviceId, $cfgIdx, $domainIdx);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClockDomainApi->getClockDomainCounters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ClockDomainApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ClockDomainApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $domainIdx = 0; # Integer | Valid top level descriptor index


eval { 
    my $result = $api_instance->getClockDomainCounters(deviceId => $deviceId, cfgIdx => $cfgIdx, domainIdx => $domainIdx);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClockDomainApi->getClockDomainCounters: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ClockDomainApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
domainIdx = 0 # Integer | Valid top level descriptor index
 (default to null)

try: 
    # Get Counters from Descriptor CLOCK_DOMAIN
    api_response = api_instance.get_clock_domain_counters(deviceId, cfgIdx, domainIdx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClockDomainApi->getClockDomainCounters: %s\n" % e)
extern crate ClockDomainApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let domainIdx = 0; // Integer

    let mut context = ClockDomainApi::Context::default();
    let result = client.getClockDomainCounters(deviceId, cfgIdx, domainIdx, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
domain_idx*
Integer
Valid top level descriptor index
Required

Responses


getDescCockDomain

Get clockDomain Descriptor


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/clockDomain/{domain_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/clockDomain/{domain_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClockDomainApi;

import java.io.File;
import java.util.*;

public class ClockDomainApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        ClockDomainApi apiInstance = new ClockDomainApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer domainIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            CLOCK_DOMAIN result = apiInstance.getDescCockDomain(deviceId, cfgIdx, domainIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClockDomainApi#getDescCockDomain");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ClockDomainApi;

public class ClockDomainApiExample {
    public static void main(String[] args) {
        ClockDomainApi apiInstance = new ClockDomainApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer domainIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            CLOCK_DOMAIN result = apiInstance.getDescCockDomain(deviceId, cfgIdx, domainIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClockDomainApi#getDescCockDomain");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ClockDomainApi *apiInstance = [[ClockDomainApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *domainIdx = 0; // Valid top level descriptor index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

// Get clockDomain Descriptor
[apiInstance getDescCockDomainWith:deviceId
    cfgIdx:cfgIdx
    domainIdx:domainIdx
    entity:entity
              completionHandler: ^(CLOCK_DOMAIN output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.ClockDomainApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var domainIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescCockDomain(deviceId, cfgIdx, domainIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescCockDomainExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new ClockDomainApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var domainIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional)  (default to null)

            try {
                // Get clockDomain Descriptor
                CLOCK_DOMAIN result = apiInstance.getDescCockDomain(deviceId, cfgIdx, domainIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ClockDomainApi.getDescCockDomain: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ClockDomainApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$domainIdx = 0; // Integer | Valid top level descriptor index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


try {
    $result = $api_instance->getDescCockDomain($deviceId, $cfgIdx, $domainIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClockDomainApi->getDescCockDomain: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ClockDomainApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ClockDomainApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $domainIdx = 0; # Integer | Valid top level descriptor index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


eval { 
    my $result = $api_instance->getDescCockDomain(deviceId => $deviceId, cfgIdx => $cfgIdx, domainIdx => $domainIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClockDomainApi->getDescCockDomain: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ClockDomainApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
domainIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

try: 
    # Get clockDomain Descriptor
    api_response = api_instance.get_desc_cock_domain(deviceId, cfgIdx, domainIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClockDomainApi->getDescCockDomain: %s\n" % e)
extern crate ClockDomainApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let domainIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = ClockDomainApi::Context::default();
    let result = client.getDescCockDomain(deviceId, cfgIdx, domainIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
domain_idx*
Integer
Valid top level descriptor index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

Responses


modifyDescCockDomain

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/clockDomain/{domain_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/clockDomain/{domain_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClockDomainApi;

import java.io.File;
import java.util.*;

public class ClockDomainApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        ClockDomainApi apiInstance = new ClockDomainApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer domainIdx = 0; // Integer | Valid top level descriptor index

        CLOCKDOMAIN1 cLOCKDOMAIN1 = {CLOCK_DOMAIN={objectName=Clock Domain A}}; // CLOCKDOMAIN1 | 
        
        try {
            CLOCK_DOMAIN result = apiInstance.modifyDescCockDomain(deviceId, cfgIdx, domainIdx, cLOCKDOMAIN1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClockDomainApi#modifyDescCockDomain");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ClockDomainApi;

public class ClockDomainApiExample {
    public static void main(String[] args) {
        ClockDomainApi apiInstance = new ClockDomainApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer domainIdx = 0; // Integer | Valid top level descriptor index

        CLOCKDOMAIN1 cLOCKDOMAIN1 = {CLOCK_DOMAIN={objectName=Clock Domain A}}; // CLOCKDOMAIN1 | 
        
        try {
            CLOCK_DOMAIN result = apiInstance.modifyDescCockDomain(deviceId, cfgIdx, domainIdx, cLOCKDOMAIN1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClockDomainApi#modifyDescCockDomain");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ClockDomainApi *apiInstance = [[ClockDomainApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *domainIdx = 0; // Valid top level descriptor index
 (default to null)
CLOCKDOMAIN1 *cLOCKDOMAIN1 = {CLOCK_DOMAIN={objectName=Clock Domain A}}; //  (optional)

// modify Descriptor variable Values
[apiInstance modifyDescCockDomainWith:deviceId
    cfgIdx:cfgIdx
    domainIdx:domainIdx
    cLOCKDOMAIN1:cLOCKDOMAIN1
              completionHandler: ^(CLOCK_DOMAIN output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.ClockDomainApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var domainIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'cLOCKDOMAIN1': {CLOCK_DOMAIN={objectName=Clock Domain A}} // {CLOCKDOMAIN1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyDescCockDomain(deviceId, cfgIdx, domainIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyDescCockDomainExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new ClockDomainApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var domainIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var cLOCKDOMAIN1 = new CLOCKDOMAIN1(); // CLOCKDOMAIN1 |  (optional) 

            try {
                // modify Descriptor variable Values
                CLOCK_DOMAIN result = apiInstance.modifyDescCockDomain(deviceId, cfgIdx, domainIdx, cLOCKDOMAIN1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ClockDomainApi.modifyDescCockDomain: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ClockDomainApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$domainIdx = 0; // Integer | Valid top level descriptor index

$cLOCKDOMAIN1 = {CLOCK_DOMAIN={objectName=Clock Domain A}}; // CLOCKDOMAIN1 | 

try {
    $result = $api_instance->modifyDescCockDomain($deviceId, $cfgIdx, $domainIdx, $cLOCKDOMAIN1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClockDomainApi->modifyDescCockDomain: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ClockDomainApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ClockDomainApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $domainIdx = 0; # Integer | Valid top level descriptor index

my $cLOCKDOMAIN1 = WWW::OPenAPIClient::Object::CLOCKDOMAIN1->new(); # CLOCKDOMAIN1 | 

eval { 
    my $result = $api_instance->modifyDescCockDomain(deviceId => $deviceId, cfgIdx => $cfgIdx, domainIdx => $domainIdx, cLOCKDOMAIN1 => $cLOCKDOMAIN1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClockDomainApi->modifyDescCockDomain: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ClockDomainApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
domainIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
cLOCKDOMAIN1 = {CLOCK_DOMAIN={objectName=Clock Domain A}} # CLOCKDOMAIN1 |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.modify_desc_cock_domain(deviceId, cfgIdx, domainIdx, cLOCKDOMAIN1=cLOCKDOMAIN1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClockDomainApi->modifyDescCockDomain: %s\n" % e)
extern crate ClockDomainApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let domainIdx = 0; // Integer
    let cLOCKDOMAIN1 = {CLOCK_DOMAIN={objectName=Clock Domain A}}; // CLOCKDOMAIN1

    let mut context = ClockDomainApi::Context::default();
    let result = client.modifyDescCockDomain(deviceId, cfgIdx, domainIdx, cLOCKDOMAIN1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
domain_idx*
Integer
Valid top level descriptor index
Required
Body parameters
Name Description
cLOCKDOMAIN1

Set Object Name

Responses


writeDescCockDomain

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/clockDomain/{domain_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/clockDomain/{domain_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClockDomainApi;

import java.io.File;
import java.util.*;

public class ClockDomainApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        ClockDomainApi apiInstance = new ClockDomainApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer domainIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            CLOCK_DOMAIN result = apiInstance.writeDescCockDomain(deviceId, cfgIdx, domainIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClockDomainApi#writeDescCockDomain");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ClockDomainApi;

public class ClockDomainApiExample {
    public static void main(String[] args) {
        ClockDomainApi apiInstance = new ClockDomainApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer domainIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            CLOCK_DOMAIN result = apiInstance.writeDescCockDomain(deviceId, cfgIdx, domainIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClockDomainApi#writeDescCockDomain");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ClockDomainApi *apiInstance = [[ClockDomainApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *domainIdx = 0; // Valid top level descriptor index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance writeDescCockDomainWith:deviceId
    cfgIdx:cfgIdx
    domainIdx:domainIdx
    length:length
    data:data
              completionHandler: ^(CLOCK_DOMAIN output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.ClockDomainApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var domainIdx = 0; // {Integer} Valid top level descriptor index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescCockDomain(deviceId, cfgIdx, domainIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescCockDomainExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new ClockDomainApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var domainIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                CLOCK_DOMAIN result = apiInstance.writeDescCockDomain(deviceId, cfgIdx, domainIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ClockDomainApi.writeDescCockDomain: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ClockDomainApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$domainIdx = 0; // Integer | Valid top level descriptor index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescCockDomain($deviceId, $cfgIdx, $domainIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClockDomainApi->writeDescCockDomain: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ClockDomainApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ClockDomainApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $domainIdx = 0; # Integer | Valid top level descriptor index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescCockDomain(deviceId => $deviceId, cfgIdx => $cfgIdx, domainIdx => $domainIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClockDomainApi->writeDescCockDomain: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ClockDomainApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
domainIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.write_desc_cock_domain(deviceId, cfgIdx, domainIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClockDomainApi->writeDescCockDomain: %s\n" % e)
extern crate ClockDomainApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let domainIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = ClockDomainApi::Context::default();
    let result = client.writeDescCockDomain(deviceId, cfgIdx, domainIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
domain_idx*
Integer
Valid top level descriptor index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


ClockSource

getClockSource

Get clockSource Descriptor


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/clockSource/{clock_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/clockSource/{clock_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClockSourceApi;

import java.io.File;
import java.util.*;

public class ClockSourceApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        ClockSourceApi apiInstance = new ClockSourceApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer clockIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            CLOCK_SOURCE result = apiInstance.getClockSource(deviceId, cfgIdx, clockIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClockSourceApi#getClockSource");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ClockSourceApi;

public class ClockSourceApiExample {
    public static void main(String[] args) {
        ClockSourceApi apiInstance = new ClockSourceApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer clockIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            CLOCK_SOURCE result = apiInstance.getClockSource(deviceId, cfgIdx, clockIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClockSourceApi#getClockSource");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ClockSourceApi *apiInstance = [[ClockSourceApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *clockIdx = 0; // Valid top level descriptor index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

// Get clockSource Descriptor
[apiInstance getClockSourceWith:deviceId
    cfgIdx:cfgIdx
    clockIdx:clockIdx
    entity:entity
              completionHandler: ^(CLOCK_SOURCE output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.ClockSourceApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var clockIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getClockSource(deviceId, cfgIdx, clockIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getClockSourceExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new ClockSourceApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var clockIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional)  (default to null)

            try {
                // Get clockSource Descriptor
                CLOCK_SOURCE result = apiInstance.getClockSource(deviceId, cfgIdx, clockIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ClockSourceApi.getClockSource: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ClockSourceApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$clockIdx = 0; // Integer | Valid top level descriptor index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


try {
    $result = $api_instance->getClockSource($deviceId, $cfgIdx, $clockIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClockSourceApi->getClockSource: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ClockSourceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ClockSourceApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $clockIdx = 0; # Integer | Valid top level descriptor index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


eval { 
    my $result = $api_instance->getClockSource(deviceId => $deviceId, cfgIdx => $cfgIdx, clockIdx => $clockIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClockSourceApi->getClockSource: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ClockSourceApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
clockIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

try: 
    # Get clockSource Descriptor
    api_response = api_instance.get_clock_source(deviceId, cfgIdx, clockIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClockSourceApi->getClockSource: %s\n" % e)
extern crate ClockSourceApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let clockIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = ClockSourceApi::Context::default();
    let result = client.getClockSource(deviceId, cfgIdx, clockIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
clock_idx*
Integer
Valid top level descriptor index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

Responses


modifyClockSource

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/clockSource/{clock_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/clockSource/{clock_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClockSourceApi;

import java.io.File;
import java.util.*;

public class ClockSourceApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        ClockSourceApi apiInstance = new ClockSourceApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer clockIdx = 0; // Integer | Valid top level descriptor index

        CLOCKSOURCE1 cLOCKSOURCE1 = {CLOCK_SOURCE={objectName=Clock Source A}}; // CLOCKSOURCE1 | 
        
        try {
            CLOCK_SOURCE result = apiInstance.modifyClockSource(deviceId, cfgIdx, clockIdx, cLOCKSOURCE1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClockSourceApi#modifyClockSource");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ClockSourceApi;

public class ClockSourceApiExample {
    public static void main(String[] args) {
        ClockSourceApi apiInstance = new ClockSourceApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer clockIdx = 0; // Integer | Valid top level descriptor index

        CLOCKSOURCE1 cLOCKSOURCE1 = {CLOCK_SOURCE={objectName=Clock Source A}}; // CLOCKSOURCE1 | 
        
        try {
            CLOCK_SOURCE result = apiInstance.modifyClockSource(deviceId, cfgIdx, clockIdx, cLOCKSOURCE1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClockSourceApi#modifyClockSource");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ClockSourceApi *apiInstance = [[ClockSourceApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *clockIdx = 0; // Valid top level descriptor index
 (default to null)
CLOCKSOURCE1 *cLOCKSOURCE1 = {CLOCK_SOURCE={objectName=Clock Source A}}; //  (optional)

// modify Descriptor variable Values
[apiInstance modifyClockSourceWith:deviceId
    cfgIdx:cfgIdx
    clockIdx:clockIdx
    cLOCKSOURCE1:cLOCKSOURCE1
              completionHandler: ^(CLOCK_SOURCE output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.ClockSourceApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var clockIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'cLOCKSOURCE1': {CLOCK_SOURCE={objectName=Clock Source A}} // {CLOCKSOURCE1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyClockSource(deviceId, cfgIdx, clockIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyClockSourceExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new ClockSourceApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var clockIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var cLOCKSOURCE1 = new CLOCKSOURCE1(); // CLOCKSOURCE1 |  (optional) 

            try {
                // modify Descriptor variable Values
                CLOCK_SOURCE result = apiInstance.modifyClockSource(deviceId, cfgIdx, clockIdx, cLOCKSOURCE1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ClockSourceApi.modifyClockSource: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ClockSourceApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$clockIdx = 0; // Integer | Valid top level descriptor index

$cLOCKSOURCE1 = {CLOCK_SOURCE={objectName=Clock Source A}}; // CLOCKSOURCE1 | 

try {
    $result = $api_instance->modifyClockSource($deviceId, $cfgIdx, $clockIdx, $cLOCKSOURCE1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClockSourceApi->modifyClockSource: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ClockSourceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ClockSourceApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $clockIdx = 0; # Integer | Valid top level descriptor index

my $cLOCKSOURCE1 = WWW::OPenAPIClient::Object::CLOCKSOURCE1->new(); # CLOCKSOURCE1 | 

eval { 
    my $result = $api_instance->modifyClockSource(deviceId => $deviceId, cfgIdx => $cfgIdx, clockIdx => $clockIdx, cLOCKSOURCE1 => $cLOCKSOURCE1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClockSourceApi->modifyClockSource: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ClockSourceApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
clockIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
cLOCKSOURCE1 = {CLOCK_SOURCE={objectName=Clock Source A}} # CLOCKSOURCE1 |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.modify_clock_source(deviceId, cfgIdx, clockIdx, cLOCKSOURCE1=cLOCKSOURCE1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClockSourceApi->modifyClockSource: %s\n" % e)
extern crate ClockSourceApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let clockIdx = 0; // Integer
    let cLOCKSOURCE1 = {CLOCK_SOURCE={objectName=Clock Source A}}; // CLOCKSOURCE1

    let mut context = ClockSourceApi::Context::default();
    let result = client.modifyClockSource(deviceId, cfgIdx, clockIdx, cLOCKSOURCE1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
clock_idx*
Integer
Valid top level descriptor index
Required
Body parameters
Name Description
cLOCKSOURCE1

Set Object Name

Responses


writeClockSource

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/clockSource/{clock_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/clockSource/{clock_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClockSourceApi;

import java.io.File;
import java.util.*;

public class ClockSourceApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        ClockSourceApi apiInstance = new ClockSourceApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer clockIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            CLOCK_SOURCE result = apiInstance.writeClockSource(deviceId, cfgIdx, clockIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClockSourceApi#writeClockSource");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ClockSourceApi;

public class ClockSourceApiExample {
    public static void main(String[] args) {
        ClockSourceApi apiInstance = new ClockSourceApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer clockIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            CLOCK_SOURCE result = apiInstance.writeClockSource(deviceId, cfgIdx, clockIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClockSourceApi#writeClockSource");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ClockSourceApi *apiInstance = [[ClockSourceApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *clockIdx = 0; // Valid top level descriptor index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance writeClockSourceWith:deviceId
    cfgIdx:cfgIdx
    clockIdx:clockIdx
    length:length
    data:data
              completionHandler: ^(CLOCK_SOURCE output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.ClockSourceApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var clockIdx = 0; // {Integer} Valid top level descriptor index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeClockSource(deviceId, cfgIdx, clockIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeClockSourceExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new ClockSourceApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var clockIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                CLOCK_SOURCE result = apiInstance.writeClockSource(deviceId, cfgIdx, clockIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ClockSourceApi.writeClockSource: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ClockSourceApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$clockIdx = 0; // Integer | Valid top level descriptor index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeClockSource($deviceId, $cfgIdx, $clockIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClockSourceApi->writeClockSource: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ClockSourceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ClockSourceApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $clockIdx = 0; # Integer | Valid top level descriptor index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeClockSource(deviceId => $deviceId, cfgIdx => $cfgIdx, clockIdx => $clockIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClockSourceApi->writeClockSource: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ClockSourceApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
clockIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.write_clock_source(deviceId, cfgIdx, clockIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClockSourceApi->writeClockSource: %s\n" % e)
extern crate ClockSourceApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let clockIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = ClockSourceApi::Context::default();
    let result = client.writeClockSource(deviceId, cfgIdx, clockIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
clock_idx*
Integer
Valid top level descriptor index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


Configuration

getDescConfiguration

Get descriptor configuration


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigurationApi;

import java.io.File;
import java.util.*;

public class ConfigurationApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        ConfigurationApi apiInstance = new ConfigurationApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer idx = 0; // Integer | valid configurations index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            CONFIGURATION result = apiInstance.getDescConfiguration(deviceId, idx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#getDescConfiguration");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ConfigurationApi;

public class ConfigurationApiExample {
    public static void main(String[] args) {
        ConfigurationApi apiInstance = new ConfigurationApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer idx = 0; // Integer | valid configurations index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            CONFIGURATION result = apiInstance.getDescConfiguration(deviceId, idx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#getDescConfiguration");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ConfigurationApi *apiInstance = [[ConfigurationApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *idx = 0; // valid configurations index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

// Get descriptor configuration
[apiInstance getDescConfigurationWith:deviceId
    idx:idx
    entity:entity
              completionHandler: ^(CONFIGURATION output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.ConfigurationApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var idx = 0; // {Integer} valid configurations index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescConfiguration(deviceId, idx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescConfigurationExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new ConfigurationApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var idx = 0;  // Integer | valid configurations index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional)  (default to null)

            try {
                // Get descriptor configuration
                CONFIGURATION result = apiInstance.getDescConfiguration(deviceId, idx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationApi.getDescConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigurationApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$idx = 0; // Integer | valid configurations index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


try {
    $result = $api_instance->getDescConfiguration($deviceId, $idx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationApi->getDescConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConfigurationApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigurationApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $idx = 0; # Integer | valid configurations index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


eval { 
    my $result = $api_instance->getDescConfiguration(deviceId => $deviceId, idx => $idx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigurationApi->getDescConfiguration: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ConfigurationApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
idx = 0 # Integer | valid configurations index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

try: 
    # Get descriptor configuration
    api_response = api_instance.get_desc_configuration(deviceId, idx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->getDescConfiguration: %s\n" % e)
extern crate ConfigurationApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let idx = 0; // Integer
    let entity = ; // array[String]

    let mut context = ConfigurationApi::Context::default();
    let result = client.getDescConfiguration(deviceId, idx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
idx*
Integer
valid configurations index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

Responses


modifyDescConfiguration

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigurationApi;

import java.io.File;
import java.util.*;

public class ConfigurationApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        ConfigurationApi apiInstance = new ConfigurationApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer idx = 0; // Integer | valid configurations index

        CONFIGURATION1 cONFIGURATION1 = {CONFIGURATION={objectName=Configuration 0}}; // CONFIGURATION1 | 
        
        try {
            CONFIGURATION result = apiInstance.modifyDescConfiguration(deviceId, idx, cONFIGURATION1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#modifyDescConfiguration");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ConfigurationApi;

public class ConfigurationApiExample {
    public static void main(String[] args) {
        ConfigurationApi apiInstance = new ConfigurationApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer idx = 0; // Integer | valid configurations index

        CONFIGURATION1 cONFIGURATION1 = {CONFIGURATION={objectName=Configuration 0}}; // CONFIGURATION1 | 
        
        try {
            CONFIGURATION result = apiInstance.modifyDescConfiguration(deviceId, idx, cONFIGURATION1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#modifyDescConfiguration");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ConfigurationApi *apiInstance = [[ConfigurationApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *idx = 0; // valid configurations index
 (default to null)
CONFIGURATION1 *cONFIGURATION1 = {CONFIGURATION={objectName=Configuration 0}}; //  (optional)

// modify Descriptor variable Values
[apiInstance modifyDescConfigurationWith:deviceId
    idx:idx
    cONFIGURATION1:cONFIGURATION1
              completionHandler: ^(CONFIGURATION output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.ConfigurationApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var idx = 0; // {Integer} valid configurations index

var opts = {
  'cONFIGURATION1': {CONFIGURATION={objectName=Configuration 0}} // {CONFIGURATION1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyDescConfiguration(deviceId, idx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyDescConfigurationExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new ConfigurationApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var idx = 0;  // Integer | valid configurations index
 (default to null)
            var cONFIGURATION1 = new CONFIGURATION1(); // CONFIGURATION1 |  (optional) 

            try {
                // modify Descriptor variable Values
                CONFIGURATION result = apiInstance.modifyDescConfiguration(deviceId, idx, cONFIGURATION1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationApi.modifyDescConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigurationApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$idx = 0; // Integer | valid configurations index

$cONFIGURATION1 = {CONFIGURATION={objectName=Configuration 0}}; // CONFIGURATION1 | 

try {
    $result = $api_instance->modifyDescConfiguration($deviceId, $idx, $cONFIGURATION1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationApi->modifyDescConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConfigurationApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigurationApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $idx = 0; # Integer | valid configurations index

my $cONFIGURATION1 = WWW::OPenAPIClient::Object::CONFIGURATION1->new(); # CONFIGURATION1 | 

eval { 
    my $result = $api_instance->modifyDescConfiguration(deviceId => $deviceId, idx => $idx, cONFIGURATION1 => $cONFIGURATION1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigurationApi->modifyDescConfiguration: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ConfigurationApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
idx = 0 # Integer | valid configurations index
 (default to null)
cONFIGURATION1 = {CONFIGURATION={objectName=Configuration 0}} # CONFIGURATION1 |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.modify_desc_configuration(deviceId, idx, cONFIGURATION1=cONFIGURATION1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->modifyDescConfiguration: %s\n" % e)
extern crate ConfigurationApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let idx = 0; // Integer
    let cONFIGURATION1 = {CONFIGURATION={objectName=Configuration 0}}; // CONFIGURATION1

    let mut context = ConfigurationApi::Context::default();
    let result = client.modifyDescConfiguration(deviceId, idx, cONFIGURATION1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
idx*
Integer
valid configurations index
Required
Body parameters
Name Description
cONFIGURATION1

Patch variable Values

Responses


writeDescConfiguration

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigurationApi;

import java.io.File;
import java.util.*;

public class ConfigurationApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        ConfigurationApi apiInstance = new ConfigurationApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer idx = 0; // Integer | valid configurations index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            CONFIGURATION result = apiInstance.writeDescConfiguration(deviceId, idx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#writeDescConfiguration");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ConfigurationApi;

public class ConfigurationApiExample {
    public static void main(String[] args) {
        ConfigurationApi apiInstance = new ConfigurationApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer idx = 0; // Integer | valid configurations index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            CONFIGURATION result = apiInstance.writeDescConfiguration(deviceId, idx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#writeDescConfiguration");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ConfigurationApi *apiInstance = [[ConfigurationApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *idx = 0; // valid configurations index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance writeDescConfigurationWith:deviceId
    idx:idx
    length:length
    data:data
              completionHandler: ^(CONFIGURATION output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.ConfigurationApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var idx = 0; // {Integer} valid configurations index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescConfiguration(deviceId, idx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescConfigurationExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new ConfigurationApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var idx = 0;  // Integer | valid configurations index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                CONFIGURATION result = apiInstance.writeDescConfiguration(deviceId, idx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationApi.writeDescConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigurationApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$idx = 0; // Integer | valid configurations index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescConfiguration($deviceId, $idx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationApi->writeDescConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConfigurationApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigurationApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $idx = 0; # Integer | valid configurations index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescConfiguration(deviceId => $deviceId, idx => $idx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigurationApi->writeDescConfiguration: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ConfigurationApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
idx = 0 # Integer | valid configurations index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.write_desc_configuration(deviceId, idx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->writeDescConfiguration: %s\n" % e)
extern crate ConfigurationApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let idx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = ConfigurationApi::Context::default();
    let result = client.writeDescConfiguration(deviceId, idx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
idx*
Integer
valid configurations index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


Control

decremControl

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *decrement* The **DECREMENT_CONTROL** command is used to decrement the specified values of a Control by the Control’s step sizes. The decrement_control command acts on a CONTROL descriptor in the current Configuration. An Entity may propagate the value change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. Note that the value only determines the index of control value, which is decremented. In response you will receive the current value, which is determined by the controlValueType. The maximum possible index is the value count described in the descriptor. option you can set the format but also have to specify the value count. The count parameter may only be used with the format parameter. Use this if the entity does not describe it with a descriptor. The values may not be displayed correctly.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/control/{control_idx}/decrement

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/control/{control_idx}/decrement"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ControlApi;

import java.io.File;
import java.util.*;

public class ControlApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        ControlApi apiInstance = new ControlApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer controlIdx = 0; // Integer | Valid top level descriptor index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.decremControl(deviceId, cfgIdx, controlIdx, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ControlApi#decremControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ControlApi;

public class ControlApiExample {
    public static void main(String[] args) {
        ControlApi apiInstance = new ControlApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer controlIdx = 0; // Integer | Valid top level descriptor index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.decremControl(deviceId, cfgIdx, controlIdx, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ControlApi#decremControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ControlApi *apiInstance = [[ControlApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *controlIdx = 0; // Valid top level descriptor index
 (default to null)
CONTROLCREMENT *cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; //  (optional)

// modify Descriptor variable Values
[apiInstance decremControlWith:deviceId
    cfgIdx:cfgIdx
    controlIdx:controlIdx
    cONTROLCREMENT:cONTROLCREMENT
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.ControlApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var controlIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'cONTROLCREMENT': {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} // {CONTROLCREMENT} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.decremControl(deviceId, cfgIdx, controlIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class decremControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new ControlApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var controlIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var cONTROLCREMENT = new CONTROLCREMENT(); // CONTROLCREMENT |  (optional) 

            try {
                // modify Descriptor variable Values
                CONTROL result = apiInstance.decremControl(deviceId, cfgIdx, controlIdx, cONTROLCREMENT);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ControlApi.decremControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ControlApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$controlIdx = 0; // Integer | Valid top level descriptor index

$cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 

try {
    $result = $api_instance->decremControl($deviceId, $cfgIdx, $controlIdx, $cONTROLCREMENT);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ControlApi->decremControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ControlApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ControlApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $controlIdx = 0; # Integer | Valid top level descriptor index

my $cONTROLCREMENT = WWW::OPenAPIClient::Object::CONTROLCREMENT->new(); # CONTROLCREMENT | 

eval { 
    my $result = $api_instance->decremControl(deviceId => $deviceId, cfgIdx => $cfgIdx, controlIdx => $controlIdx, cONTROLCREMENT => $cONTROLCREMENT);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ControlApi->decremControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ControlApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
controlIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} # CONTROLCREMENT |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.decrem_control(deviceId, cfgIdx, controlIdx, cONTROLCREMENT=cONTROLCREMENT)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControlApi->decremControl: %s\n" % e)
extern crate ControlApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let controlIdx = 0; // Integer
    let cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT

    let mut context = ControlApi::Context::default();
    let result = client.decremControl(deviceId, cfgIdx, controlIdx, cONTROLCREMENT, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
control_idx*
Integer
Valid top level descriptor index
Required
Body parameters
Name Description
cONTROLCREMENT

Set Object Name and Control Value

Responses


getDescControl

Get control Descriptor


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/control/{control_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/control/{control_idx}?entity=&format="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ControlApi;

import java.io.File;
import java.util.*;

public class ControlApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        ControlApi apiInstance = new ControlApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer controlIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

        Format7 format = ; // Format7 | specific value Control Value 

        
        try {
            CONTROL result = apiInstance.getDescControl(deviceId, cfgIdx, controlIdx, entity, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ControlApi#getDescControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ControlApi;

public class ControlApiExample {
    public static void main(String[] args) {
        ControlApi apiInstance = new ControlApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer controlIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

        Format7 format = ; // Format7 | specific value Control Value 

        
        try {
            CONTROL result = apiInstance.getDescControl(deviceId, cfgIdx, controlIdx, entity, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ControlApi#getDescControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ControlApi *apiInstance = [[ControlApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *controlIdx = 0; // Valid top level descriptor index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
 (optional) (default to null)
Format7 *format = ; // specific value Control Value 
 (optional) (default to null)

// Get control Descriptor
[apiInstance getDescControlWith:deviceId
    cfgIdx:cfgIdx
    controlIdx:controlIdx
    entity:entity
    format:format
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.ControlApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var controlIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'entity': , // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

  'format':  // {Format7} specific value Control Value 

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescControl(deviceId, cfgIdx, controlIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new ControlApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var controlIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
 (optional)  (default to null)
            var format = new Format7(); // Format7 | specific value Control Value 
 (optional)  (default to null)

            try {
                // Get control Descriptor
                CONTROL result = apiInstance.getDescControl(deviceId, cfgIdx, controlIdx, entity, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ControlApi.getDescControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ControlApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$controlIdx = 0; // Integer | Valid top level descriptor index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

$format = ; // Format7 | specific value Control Value 


try {
    $result = $api_instance->getDescControl($deviceId, $cfgIdx, $controlIdx, $entity, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ControlApi->getDescControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ControlApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ControlApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $controlIdx = 0; # Integer | Valid top level descriptor index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.

my $format = ; # Format7 | specific value Control Value 


eval { 
    my $result = $api_instance->getDescControl(deviceId => $deviceId, cfgIdx => $cfgIdx, controlIdx => $controlIdx, entity => $entity, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ControlApi->getDescControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ControlApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
controlIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*value* The **GET_CONTROL** command is used to get the current values of a Control. 
The get_control command returns the value for the currently active Configuration. 
The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
 (optional) (default to null)
format =  # Format7 | specific value Control Value 
 (optional) (default to null)

try: 
    # Get control Descriptor
    api_response = api_instance.get_desc_control(deviceId, cfgIdx, controlIdx, entity=entity, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControlApi->getDescControl: %s\n" % e)
extern crate ControlApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let controlIdx = 0; // Integer
    let entity = ; // array[String]
    let format = ; // Format7

    let mut context = ControlApi::Context::default();
    let result = client.getDescControl(deviceId, cfgIdx, controlIdx, entity, format, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
control_idx*
Integer
Valid top level descriptor index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *value* The **GET_CONTROL** command is used to get the current values of a Control. The get_control command returns the value for the currently active Configuration. The answer depends on the valueValueType and value count. Please have a look at the extended documentation.
format
Format7
specific value Control Value

Responses


incremControl

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *increment* The **INCREMENT_CONTROL** command is used to increment the specified values of a Control by the Control’s step sizes. The increment_control command acts on a CONTROL descriptor in the current Configuration. An Entity may propagate the format change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. Note that the value only determines the index of control value, which is incremented. In response you will receive the current value, which is determined by the controlValueType. The maximum possible index is the value count described in the descriptor.option you can set the format but also have to specify the value count. The count parameter may only be used with the format parameter. Use this if the entity does not describe it with a descriptor. The values may not be displayed correctly.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/control/{control_idx}/increment

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/control/{control_idx}/increment"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ControlApi;

import java.io.File;
import java.util.*;

public class ControlApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        ControlApi apiInstance = new ControlApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer controlIdx = 0; // Integer | Valid top level descriptor index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.incremControl(deviceId, cfgIdx, controlIdx, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ControlApi#incremControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ControlApi;

public class ControlApiExample {
    public static void main(String[] args) {
        ControlApi apiInstance = new ControlApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer controlIdx = 0; // Integer | Valid top level descriptor index

        CONTROLCREMENT cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 
        
        try {
            CONTROL result = apiInstance.incremControl(deviceId, cfgIdx, controlIdx, cONTROLCREMENT);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ControlApi#incremControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ControlApi *apiInstance = [[ControlApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *controlIdx = 0; // Valid top level descriptor index
 (default to null)
CONTROLCREMENT *cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; //  (optional)

// modify Descriptor variable Values
[apiInstance incremControlWith:deviceId
    cfgIdx:cfgIdx
    controlIdx:controlIdx
    cONTROLCREMENT:cONTROLCREMENT
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.ControlApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var controlIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'cONTROLCREMENT': {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} // {CONTROLCREMENT} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.incremControl(deviceId, cfgIdx, controlIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class incremControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new ControlApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var controlIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var cONTROLCREMENT = new CONTROLCREMENT(); // CONTROLCREMENT |  (optional) 

            try {
                // modify Descriptor variable Values
                CONTROL result = apiInstance.incremControl(deviceId, cfgIdx, controlIdx, cONTROLCREMENT);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ControlApi.incremControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ControlApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$controlIdx = 0; // Integer | Valid top level descriptor index

$cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT | 

try {
    $result = $api_instance->incremControl($deviceId, $cfgIdx, $controlIdx, $cONTROLCREMENT);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ControlApi->incremControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ControlApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ControlApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $controlIdx = 0; # Integer | Valid top level descriptor index

my $cONTROLCREMENT = WWW::OPenAPIClient::Object::CONTROLCREMENT->new(); # CONTROLCREMENT | 

eval { 
    my $result = $api_instance->incremControl(deviceId => $deviceId, cfgIdx => $cfgIdx, controlIdx => $controlIdx, cONTROLCREMENT => $cONTROLCREMENT);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ControlApi->incremControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ControlApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
controlIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}} # CONTROLCREMENT |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.increm_control(deviceId, cfgIdx, controlIdx, cONTROLCREMENT=cONTROLCREMENT)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControlApi->incremControl: %s\n" % e)
extern crate ControlApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let controlIdx = 0; // Integer
    let cONTROLCREMENT = {CONTROL={value={LINEAR_UINT8={numberValues=1, idx=[10]}}}}; // CONTROLCREMENT

    let mut context = ControlApi::Context::default();
    let result = client.incremControl(deviceId, cfgIdx, controlIdx, cONTROLCREMENT, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
control_idx*
Integer
Valid top level descriptor index
Required
Body parameters
Name Description
cONTROLCREMENT

Set Object Name and Control Value

Responses


modifyDescControl

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command. *value* The **SET_CONTROL** command is used to change the values of a Control. The set_control command acts on a descriptor in the current Configuration. An AVDECC Entity may propagate the value change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. The parameters depend on the controlValueType, please look in the extended documentation for which parameters can be set. option you can set the controlValType but also have to specify the value count. The count parameter may only be used with the format parameter. Use this if the entity does not describe it with a descriptor. The values may not be displayed correctly.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/control/{control_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/control/{control_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ControlApi;

import java.io.File;
import java.util.*;

public class ControlApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        ControlApi apiInstance = new ControlApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer controlIdx = 0; // Integer | Valid top level descriptor index

        CONTROL1 cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1 | 
        
        try {
            CONTROL result = apiInstance.modifyDescControl(deviceId, cfgIdx, controlIdx, cONTROL1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ControlApi#modifyDescControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ControlApi;

public class ControlApiExample {
    public static void main(String[] args) {
        ControlApi apiInstance = new ControlApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer controlIdx = 0; // Integer | Valid top level descriptor index

        CONTROL1 cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1 | 
        
        try {
            CONTROL result = apiInstance.modifyDescControl(deviceId, cfgIdx, controlIdx, cONTROL1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ControlApi#modifyDescControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ControlApi *apiInstance = [[ControlApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *controlIdx = 0; // Valid top level descriptor index
 (default to null)
CONTROL1 *cONTROL1 = {CONTROL={objectName=Control 0}}; //  (optional)

// modify Descriptor variable Values
[apiInstance modifyDescControlWith:deviceId
    cfgIdx:cfgIdx
    controlIdx:controlIdx
    cONTROL1:cONTROL1
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.ControlApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var controlIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'cONTROL1': {CONTROL={objectName=Control 0}} // {CONTROL1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyDescControl(deviceId, cfgIdx, controlIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyDescControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new ControlApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var controlIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var cONTROL1 = new CONTROL1(); // CONTROL1 |  (optional) 

            try {
                // modify Descriptor variable Values
                CONTROL result = apiInstance.modifyDescControl(deviceId, cfgIdx, controlIdx, cONTROL1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ControlApi.modifyDescControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ControlApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$controlIdx = 0; // Integer | Valid top level descriptor index

$cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1 | 

try {
    $result = $api_instance->modifyDescControl($deviceId, $cfgIdx, $controlIdx, $cONTROL1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ControlApi->modifyDescControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ControlApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ControlApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $controlIdx = 0; # Integer | Valid top level descriptor index

my $cONTROL1 = WWW::OPenAPIClient::Object::CONTROL1->new(); # CONTROL1 | 

eval { 
    my $result = $api_instance->modifyDescControl(deviceId => $deviceId, cfgIdx => $cfgIdx, controlIdx => $controlIdx, cONTROL1 => $cONTROL1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ControlApi->modifyDescControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ControlApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
controlIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
cONTROL1 = {CONTROL={objectName=Control 0}} # CONTROL1 |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.modify_desc_control(deviceId, cfgIdx, controlIdx, cONTROL1=cONTROL1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControlApi->modifyDescControl: %s\n" % e)
extern crate ControlApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let controlIdx = 0; // Integer
    let cONTROL1 = {CONTROL={objectName=Control 0}}; // CONTROL1

    let mut context = ControlApi::Context::default();
    let result = client.modifyDescControl(deviceId, cfgIdx, controlIdx, cONTROL1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
control_idx*
Integer
Valid top level descriptor index
Required
Body parameters
Name Description
cONTROL1

Set Object Name and Control Value

Responses


writeDescControl

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/control/{control_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/control/{control_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ControlApi;

import java.io.File;
import java.util.*;

public class ControlApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        ControlApi apiInstance = new ControlApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer controlIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            CONTROL result = apiInstance.writeDescControl(deviceId, cfgIdx, controlIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ControlApi#writeDescControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ControlApi;

public class ControlApiExample {
    public static void main(String[] args) {
        ControlApi apiInstance = new ControlApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer controlIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            CONTROL result = apiInstance.writeDescControl(deviceId, cfgIdx, controlIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ControlApi#writeDescControl");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ControlApi *apiInstance = [[ControlApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *controlIdx = 0; // Valid top level descriptor index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance writeDescControlWith:deviceId
    cfgIdx:cfgIdx
    controlIdx:controlIdx
    length:length
    data:data
              completionHandler: ^(CONTROL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.ControlApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var controlIdx = 0; // {Integer} Valid top level descriptor index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescControl(deviceId, cfgIdx, controlIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescControlExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new ControlApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var controlIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                CONTROL result = apiInstance.writeDescControl(deviceId, cfgIdx, controlIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ControlApi.writeDescControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ControlApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$controlIdx = 0; // Integer | Valid top level descriptor index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescControl($deviceId, $cfgIdx, $controlIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ControlApi->writeDescControl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ControlApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ControlApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $controlIdx = 0; # Integer | Valid top level descriptor index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescControl(deviceId => $deviceId, cfgIdx => $cfgIdx, controlIdx => $controlIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ControlApi->writeDescControl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ControlApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
controlIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.write_desc_control(deviceId, cfgIdx, controlIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControlApi->writeDescControl: %s\n" % e)
extern crate ControlApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let controlIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = ControlApi::Context::default();
    let result = client.writeDescControl(deviceId, cfgIdx, controlIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
control_idx*
Integer
Valid top level descriptor index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


ControlBlock

getDescControlBlock

Get clockDomain Descriptor


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/controlBlock/{block_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/controlBlock/{block_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ControlBlockApi;

import java.io.File;
import java.util.*;

public class ControlBlockApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        ControlBlockApi apiInstance = new ControlBlockApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer blockIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | get all Values from entity, not from database

        
        try {
            CONTROL_BLOCK result = apiInstance.getDescControlBlock(deviceId, cfgIdx, blockIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ControlBlockApi#getDescControlBlock");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ControlBlockApi;

public class ControlBlockApiExample {
    public static void main(String[] args) {
        ControlBlockApi apiInstance = new ControlBlockApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer blockIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | get all Values from entity, not from database

        
        try {
            CONTROL_BLOCK result = apiInstance.getDescControlBlock(deviceId, cfgIdx, blockIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ControlBlockApi#getDescControlBlock");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ControlBlockApi *apiInstance = [[ControlBlockApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *blockIdx = 0; // Valid top level descriptor index
 (default to null)
array[String] *entity = ; // get all Values from entity, not from database
 (optional) (default to null)

// Get clockDomain Descriptor
[apiInstance getDescControlBlockWith:deviceId
    cfgIdx:cfgIdx
    blockIdx:blockIdx
    entity:entity
              completionHandler: ^(CONTROL_BLOCK output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.ControlBlockApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var blockIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'entity':  // {array[String]} get all Values from entity, not from database

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescControlBlock(deviceId, cfgIdx, blockIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescControlBlockExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new ControlBlockApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var blockIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var entity = new array[String](); // array[String] | get all Values from entity, not from database
 (optional)  (default to null)

            try {
                // Get clockDomain Descriptor
                CONTROL_BLOCK result = apiInstance.getDescControlBlock(deviceId, cfgIdx, blockIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ControlBlockApi.getDescControlBlock: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ControlBlockApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$blockIdx = 0; // Integer | Valid top level descriptor index

$entity = ; // array[String] | get all Values from entity, not from database


try {
    $result = $api_instance->getDescControlBlock($deviceId, $cfgIdx, $blockIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ControlBlockApi->getDescControlBlock: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ControlBlockApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ControlBlockApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $blockIdx = 0; # Integer | Valid top level descriptor index

my $entity = []; # array[String] | get all Values from entity, not from database


eval { 
    my $result = $api_instance->getDescControlBlock(deviceId => $deviceId, cfgIdx => $cfgIdx, blockIdx => $blockIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ControlBlockApi->getDescControlBlock: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ControlBlockApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
blockIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
entity =  # array[String] | get all Values from entity, not from database
 (optional) (default to null)

try: 
    # Get clockDomain Descriptor
    api_response = api_instance.get_desc_control_block(deviceId, cfgIdx, blockIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControlBlockApi->getDescControlBlock: %s\n" % e)
extern crate ControlBlockApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let blockIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = ControlBlockApi::Context::default();
    let result = client.getDescControlBlock(deviceId, cfgIdx, blockIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
block_idx*
Integer
Valid top level descriptor index
Required
Query parameters
Name Description
entity
array[String]
get all Values from entity, not from database

Responses


writeDescControlBlock

Write Descriptor in device

The *write_descriptor* command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/controlBlock/{block_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/controlBlock/{block_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ControlBlockApi;

import java.io.File;
import java.util.*;

public class ControlBlockApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        ControlBlockApi apiInstance = new ControlBlockApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer blockIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            CONTROL_BLOCK result = apiInstance.writeDescControlBlock(deviceId, cfgIdx, blockIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ControlBlockApi#writeDescControlBlock");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ControlBlockApi;

public class ControlBlockApiExample {
    public static void main(String[] args) {
        ControlBlockApi apiInstance = new ControlBlockApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer blockIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            CONTROL_BLOCK result = apiInstance.writeDescControlBlock(deviceId, cfgIdx, blockIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ControlBlockApi#writeDescControlBlock");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ControlBlockApi *apiInstance = [[ControlBlockApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *blockIdx = 0; // Valid top level descriptor index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance writeDescControlBlockWith:deviceId
    cfgIdx:cfgIdx
    blockIdx:blockIdx
    length:length
    data:data
              completionHandler: ^(CONTROL_BLOCK output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.ControlBlockApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var blockIdx = 0; // {Integer} Valid top level descriptor index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescControlBlock(deviceId, cfgIdx, blockIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescControlBlockExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new ControlBlockApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var blockIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                CONTROL_BLOCK result = apiInstance.writeDescControlBlock(deviceId, cfgIdx, blockIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ControlBlockApi.writeDescControlBlock: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ControlBlockApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$blockIdx = 0; // Integer | Valid top level descriptor index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescControlBlock($deviceId, $cfgIdx, $blockIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ControlBlockApi->writeDescControlBlock: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ControlBlockApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ControlBlockApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $blockIdx = 0; # Integer | Valid top level descriptor index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescControlBlock(deviceId => $deviceId, cfgIdx => $cfgIdx, blockIdx => $blockIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ControlBlockApi->writeDescControlBlock: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ControlBlockApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
blockIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.write_desc_control_block(deviceId, cfgIdx, blockIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControlBlockApi->writeDescControlBlock: %s\n" % e)
extern crate ControlBlockApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let blockIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = ControlBlockApi::Context::default();
    let result = client.writeDescControlBlock(deviceId, cfgIdx, blockIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
block_idx*
Integer
Valid top level descriptor index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


Controller

getCotrollerInfo

Controller Info


/v1.0/controller/info

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/controller/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ControllerApi;

import java.io.File;
import java.util.*;

public class ControllerApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        ControllerApi apiInstance = new ControllerApi();
        
        try {
            inline_response_200_1 result = apiInstance.getCotrollerInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ControllerApi#getCotrollerInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ControllerApi;

public class ControllerApiExample {
    public static void main(String[] args) {
        ControllerApi apiInstance = new ControllerApi();
        
        try {
            inline_response_200_1 result = apiInstance.getCotrollerInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ControllerApi#getCotrollerInfo");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ControllerApi *apiInstance = [[ControllerApi alloc] init];

// Controller Info
[apiInstance getCotrollerInfoWithCompletionHandler: 
              ^(inline_response_200_1 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.ControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCotrollerInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCotrollerInfoExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new ControllerApi();

            try {
                // Controller Info
                inline_response_200_1 result = apiInstance.getCotrollerInfo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ControllerApi.getCotrollerInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ControllerApi();

try {
    $result = $api_instance->getCotrollerInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ControllerApi->getCotrollerInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ControllerApi->new();

eval { 
    my $result = $api_instance->getCotrollerInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ControllerApi->getCotrollerInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ControllerApi()

try: 
    # Controller Info
    api_response = api_instance.get_cotroller_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControllerApi->getCotrollerInfo: %s\n" % e)
extern crate ControllerApi;

pub fn main() {

    let mut context = ControllerApi::Context::default();
    let result = client.getCotrollerInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


Descriptors

delDescriptors

Refresh all Descriptors from entity


/v1.0/devices/{deviceId}/descriptor

Usage and SDK Samples

curl -X DELETE\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsApi;

import java.io.File;
import java.util.*;

public class DescriptorsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsApi apiInstance = new DescriptorsApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identfier

        
        try {
            inline_response_200_3 result = apiInstance.delDescriptors(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsApi#delDescriptors");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsApi;

public class DescriptorsApiExample {
    public static void main(String[] args) {
        DescriptorsApi apiInstance = new DescriptorsApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identfier

        
        try {
            inline_response_200_3 result = apiInstance.delDescriptors(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsApi#delDescriptors");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsApi *apiInstance = [[DescriptorsApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identfier
 (default to null)

// Refresh all Descriptors from entity
[apiInstance delDescriptorsWith:deviceId
              completionHandler: ^(inline_response_200_3 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identfier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.delDescriptors(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class delDescriptorsExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identfier
 (default to null)

            try {
                // Refresh all Descriptors from entity
                inline_response_200_3 result = apiInstance.delDescriptors(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsApi.delDescriptors: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identfier


try {
    $result = $api_instance->delDescriptors($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsApi->delDescriptors: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identfier


eval { 
    my $result = $api_instance->delDescriptors(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsApi->delDescriptors: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identfier
 (default to null)

try: 
    # Refresh all Descriptors from entity
    api_response = api_instance.del_descriptors(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsApi->delDescriptors: %s\n" % e)
extern crate DescriptorsApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = DescriptorsApi::Context::default();
    let result = client.delDescriptors(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identfier
Required

Responses


getDecscriptors

Get HAL Descriptors link


/v1.0/devices/{deviceId}/descriptor

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsApi;

import java.io.File;
import java.util.*;

public class DescriptorsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsApi apiInstance = new DescriptorsApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identfier

        
        try {
            inline_response_200_5 result = apiInstance.getDecscriptors(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsApi#getDecscriptors");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsApi;

public class DescriptorsApiExample {
    public static void main(String[] args) {
        DescriptorsApi apiInstance = new DescriptorsApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identfier

        
        try {
            inline_response_200_5 result = apiInstance.getDecscriptors(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsApi#getDecscriptors");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsApi *apiInstance = [[DescriptorsApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identfier
 (default to null)

// Get HAL Descriptors link
[apiInstance getDecscriptorsWith:deviceId
              completionHandler: ^(inline_response_200_5 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identfier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDecscriptors(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDecscriptorsExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identfier
 (default to null)

            try {
                // Get HAL Descriptors link
                inline_response_200_5 result = apiInstance.getDecscriptors(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsApi.getDecscriptors: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identfier


try {
    $result = $api_instance->getDecscriptors($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsApi->getDecscriptors: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identfier


eval { 
    my $result = $api_instance->getDecscriptors(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsApi->getDecscriptors: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identfier
 (default to null)

try: 
    # Get HAL Descriptors link
    api_response = api_instance.get_decscriptors(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsApi->getDecscriptors: %s\n" % e)
extern crate DescriptorsApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = DescriptorsApi::Context::default();
    let result = client.getDecscriptors(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identfier
Required

Responses


DescriptorsAudioUnitControlBlock

v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxGet

Get Descriptor AudioUnit controlBlock


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/controlBlock/{block_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/controlBlock/{block_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitControlBlockApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitControlBlockApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitControlBlockApi apiInstance = new DescriptorsAudioUnitControlBlockApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer blockIdx = 0; // Integer | Descriptor CONTROL_BLOCK index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            CONTROL_BLOCK result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxGet(deviceId, cfgIdx, audioUnitIdx, blockIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitControlBlockApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitControlBlockApi;

public class DescriptorsAudioUnitControlBlockApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitControlBlockApi apiInstance = new DescriptorsAudioUnitControlBlockApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer blockIdx = 0; // Integer | Descriptor CONTROL_BLOCK index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            CONTROL_BLOCK result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxGet(deviceId, cfgIdx, audioUnitIdx, blockIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitControlBlockApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitControlBlockApi *apiInstance = [[DescriptorsAudioUnitControlBlockApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *blockIdx = 0; // Descriptor CONTROL_BLOCK index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

// Get Descriptor AudioUnit controlBlock
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxGetWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    blockIdx:blockIdx
    entity:entity
              completionHandler: ^(CONTROL_BLOCK output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitControlBlockApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var blockIdx = 0; // {Integer} Descriptor CONTROL_BLOCK index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxGet(deviceId, cfgIdx, audioUnitIdx, blockIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxGetExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitControlBlockApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var blockIdx = 0;  // Integer | Descriptor CONTROL_BLOCK index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional)  (default to null)

            try {
                // Get Descriptor AudioUnit controlBlock
                CONTROL_BLOCK result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxGet(deviceId, cfgIdx, audioUnitIdx, blockIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitControlBlockApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitControlBlockApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$blockIdx = 0; // Integer | Descriptor CONTROL_BLOCK index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxGet($deviceId, $cfgIdx, $audioUnitIdx, $blockIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitControlBlockApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitControlBlockApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitControlBlockApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $blockIdx = 0; # Integer | Descriptor CONTROL_BLOCK index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxGet(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, blockIdx => $blockIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitControlBlockApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitControlBlockApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
blockIdx = 0 # Integer | Descriptor CONTROL_BLOCK index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

try: 
    # Get Descriptor AudioUnit controlBlock
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_control_block_block_idx_get(deviceId, cfgIdx, audioUnitIdx, blockIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitControlBlockApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxGet: %s\n" % e)
extern crate DescriptorsAudioUnitControlBlockApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let blockIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = DescriptorsAudioUnitControlBlockApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxGet(deviceId, cfgIdx, audioUnitIdx, blockIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
block_idx*
Integer
Descriptor CONTROL_BLOCK index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

Responses


v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPatch

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/controlBlock/{block_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/controlBlock/{block_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitControlBlockApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitControlBlockApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitControlBlockApi apiInstance = new DescriptorsAudioUnitControlBlockApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer blockIdx = 0; // Integer | Descriptor CONTROL_BLOCK index

        CONTROLBLOCK cONTROLBLOCK = {CONTROL_BLOCK={objectName=Controlblock 0}}; // CONTROLBLOCK | 
        
        try {
            CONTROL_BLOCK result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPatch(deviceId, cfgIdx, audioUnitIdx, blockIdx, cONTROLBLOCK);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitControlBlockApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPatch");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitControlBlockApi;

public class DescriptorsAudioUnitControlBlockApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitControlBlockApi apiInstance = new DescriptorsAudioUnitControlBlockApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer blockIdx = 0; // Integer | Descriptor CONTROL_BLOCK index

        CONTROLBLOCK cONTROLBLOCK = {CONTROL_BLOCK={objectName=Controlblock 0}}; // CONTROLBLOCK | 
        
        try {
            CONTROL_BLOCK result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPatch(deviceId, cfgIdx, audioUnitIdx, blockIdx, cONTROLBLOCK);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitControlBlockApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPatch");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitControlBlockApi *apiInstance = [[DescriptorsAudioUnitControlBlockApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *blockIdx = 0; // Descriptor CONTROL_BLOCK index
 (default to null)
CONTROLBLOCK *cONTROLBLOCK = {CONTROL_BLOCK={objectName=Controlblock 0}}; //  (optional)

// modify Descriptor variable Values
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPatchWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    blockIdx:blockIdx
    cONTROLBLOCK:cONTROLBLOCK
              completionHandler: ^(CONTROL_BLOCK output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitControlBlockApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var blockIdx = 0; // {Integer} Descriptor CONTROL_BLOCK index

var opts = {
  'cONTROLBLOCK': {CONTROL_BLOCK={objectName=Controlblock 0}} // {CONTROLBLOCK} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPatch(deviceId, cfgIdx, audioUnitIdx, blockIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPatchExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitControlBlockApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var blockIdx = 0;  // Integer | Descriptor CONTROL_BLOCK index
 (default to null)
            var cONTROLBLOCK = new CONTROLBLOCK(); // CONTROLBLOCK |  (optional) 

            try {
                // modify Descriptor variable Values
                CONTROL_BLOCK result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPatch(deviceId, cfgIdx, audioUnitIdx, blockIdx, cONTROLBLOCK);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitControlBlockApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitControlBlockApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$blockIdx = 0; // Integer | Descriptor CONTROL_BLOCK index

$cONTROLBLOCK = {CONTROL_BLOCK={objectName=Controlblock 0}}; // CONTROLBLOCK | 

try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPatch($deviceId, $cfgIdx, $audioUnitIdx, $blockIdx, $cONTROLBLOCK);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitControlBlockApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitControlBlockApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitControlBlockApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $blockIdx = 0; # Integer | Descriptor CONTROL_BLOCK index

my $cONTROLBLOCK = WWW::OPenAPIClient::Object::CONTROLBLOCK->new(); # CONTROLBLOCK | 

eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPatch(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, blockIdx => $blockIdx, cONTROLBLOCK => $cONTROLBLOCK);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitControlBlockApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPatch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitControlBlockApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
blockIdx = 0 # Integer | Descriptor CONTROL_BLOCK index
 (default to null)
cONTROLBLOCK = {CONTROL_BLOCK={objectName=Controlblock 0}} # CONTROLBLOCK |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_control_block_block_idx_patch(deviceId, cfgIdx, audioUnitIdx, blockIdx, cONTROLBLOCK=cONTROLBLOCK)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitControlBlockApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPatch: %s\n" % e)
extern crate DescriptorsAudioUnitControlBlockApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let blockIdx = 0; // Integer
    let cONTROLBLOCK = {CONTROL_BLOCK={objectName=Controlblock 0}}; // CONTROLBLOCK

    let mut context = DescriptorsAudioUnitControlBlockApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPatch(deviceId, cfgIdx, audioUnitIdx, blockIdx, cONTROLBLOCK, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
block_idx*
Integer
Descriptor CONTROL_BLOCK index
Required
Body parameters
Name Description
cONTROLBLOCK

Patch variable Values

Responses


v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPut

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/controlBlock/{block_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/controlBlock/{block_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitControlBlockApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitControlBlockApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitControlBlockApi apiInstance = new DescriptorsAudioUnitControlBlockApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer blockIdx = 0; // Integer | Descriptor CONTROL_BLOCK index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            CONTROL_BLOCK result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPut(deviceId, cfgIdx, audioUnitIdx, blockIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitControlBlockApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPut");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitControlBlockApi;

public class DescriptorsAudioUnitControlBlockApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitControlBlockApi apiInstance = new DescriptorsAudioUnitControlBlockApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer blockIdx = 0; // Integer | Descriptor CONTROL_BLOCK index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            CONTROL_BLOCK result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPut(deviceId, cfgIdx, audioUnitIdx, blockIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitControlBlockApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPut");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitControlBlockApi *apiInstance = [[DescriptorsAudioUnitControlBlockApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *blockIdx = 0; // Descriptor CONTROL_BLOCK index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPutWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    blockIdx:blockIdx
    length:length
    data:data
              completionHandler: ^(CONTROL_BLOCK output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitControlBlockApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var blockIdx = 0; // {Integer} Descriptor CONTROL_BLOCK index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPut(deviceId, cfgIdx, audioUnitIdx, blockIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPutExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitControlBlockApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var blockIdx = 0;  // Integer | Descriptor CONTROL_BLOCK index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                CONTROL_BLOCK result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPut(deviceId, cfgIdx, audioUnitIdx, blockIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitControlBlockApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitControlBlockApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$blockIdx = 0; // Integer | Descriptor CONTROL_BLOCK index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPut($deviceId, $cfgIdx, $audioUnitIdx, $blockIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitControlBlockApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitControlBlockApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitControlBlockApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $blockIdx = 0; # Integer | Descriptor CONTROL_BLOCK index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPut(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, blockIdx => $blockIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitControlBlockApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitControlBlockApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
blockIdx = 0 # Integer | Descriptor CONTROL_BLOCK index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_control_block_block_idx_put(deviceId, cfgIdx, audioUnitIdx, blockIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitControlBlockApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPut: %s\n" % e)
extern crate DescriptorsAudioUnitControlBlockApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let blockIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = DescriptorsAudioUnitControlBlockApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxControlBlockBlockIdxPut(deviceId, cfgIdx, audioUnitIdx, blockIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
block_idx*
Integer
Descriptor CONTROL_BLOCK index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


DescriptorsAudioUnitDemultiplexer

v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxGet

Get Descriptor AudioUnit demultiplexer


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/demultiplexer/{multiplexer_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/demultiplexer/{multiplexer_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitDemultiplexerApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitDemultiplexerApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitDemultiplexerApi apiInstance = new DescriptorsAudioUnitDemultiplexerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer multiplexerIdx = 0; // Integer | Descriptor SIGNAL_DEMULTIPLEXER index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            SIGNAL_DEMULTIPLEXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxGet(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitDemultiplexerApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitDemultiplexerApi;

public class DescriptorsAudioUnitDemultiplexerApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitDemultiplexerApi apiInstance = new DescriptorsAudioUnitDemultiplexerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer multiplexerIdx = 0; // Integer | Descriptor SIGNAL_DEMULTIPLEXER index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            SIGNAL_DEMULTIPLEXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxGet(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitDemultiplexerApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitDemultiplexerApi *apiInstance = [[DescriptorsAudioUnitDemultiplexerApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *multiplexerIdx = 0; // Descriptor SIGNAL_DEMULTIPLEXER index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

// Get Descriptor AudioUnit demultiplexer
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxGetWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    multiplexerIdx:multiplexerIdx
    entity:entity
              completionHandler: ^(SIGNAL_DEMULTIPLEXER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitDemultiplexerApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var multiplexerIdx = 0; // {Integer} Descriptor SIGNAL_DEMULTIPLEXER index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxGet(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxGetExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitDemultiplexerApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var multiplexerIdx = 0;  // Integer | Descriptor SIGNAL_DEMULTIPLEXER index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional)  (default to null)

            try {
                // Get Descriptor AudioUnit demultiplexer
                SIGNAL_DEMULTIPLEXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxGet(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitDemultiplexerApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitDemultiplexerApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$multiplexerIdx = 0; // Integer | Descriptor SIGNAL_DEMULTIPLEXER index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxGet($deviceId, $cfgIdx, $audioUnitIdx, $multiplexerIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitDemultiplexerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitDemultiplexerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitDemultiplexerApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $multiplexerIdx = 0; # Integer | Descriptor SIGNAL_DEMULTIPLEXER index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxGet(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, multiplexerIdx => $multiplexerIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitDemultiplexerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitDemultiplexerApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
multiplexerIdx = 0 # Integer | Descriptor SIGNAL_DEMULTIPLEXER index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

try: 
    # Get Descriptor AudioUnit demultiplexer
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_demultiplexer_multiplexer_idx_get(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitDemultiplexerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxGet: %s\n" % e)
extern crate DescriptorsAudioUnitDemultiplexerApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let multiplexerIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = DescriptorsAudioUnitDemultiplexerApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxGet(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
multiplexer_idx*
Integer
Descriptor SIGNAL_DEMULTIPLEXER index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

Responses


v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPatch

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/demultiplexer/{multiplexer_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/demultiplexer/{multiplexer_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitDemultiplexerApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitDemultiplexerApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitDemultiplexerApi apiInstance = new DescriptorsAudioUnitDemultiplexerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer multiplexerIdx = 0; // Integer | Descriptor SIGNAL_DEMULTIPLEXER index

        SIGNALDEMULTIPLEXER1 sIGNALDEMULTIPLEXER1 = {SIGNAL_DEMULTIPLEXER={objectName=Demultiplexer 0}}; // SIGNALDEMULTIPLEXER1 | 
        
        try {
            SIGNAL_DEMULTIPLEXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPatch(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, sIGNALDEMULTIPLEXER1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitDemultiplexerApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPatch");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitDemultiplexerApi;

public class DescriptorsAudioUnitDemultiplexerApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitDemultiplexerApi apiInstance = new DescriptorsAudioUnitDemultiplexerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer multiplexerIdx = 0; // Integer | Descriptor SIGNAL_DEMULTIPLEXER index

        SIGNALDEMULTIPLEXER1 sIGNALDEMULTIPLEXER1 = {SIGNAL_DEMULTIPLEXER={objectName=Demultiplexer 0}}; // SIGNALDEMULTIPLEXER1 | 
        
        try {
            SIGNAL_DEMULTIPLEXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPatch(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, sIGNALDEMULTIPLEXER1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitDemultiplexerApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPatch");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitDemultiplexerApi *apiInstance = [[DescriptorsAudioUnitDemultiplexerApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *multiplexerIdx = 0; // Descriptor SIGNAL_DEMULTIPLEXER index
 (default to null)
SIGNALDEMULTIPLEXER1 *sIGNALDEMULTIPLEXER1 = {SIGNAL_DEMULTIPLEXER={objectName=Demultiplexer 0}}; //  (optional)

// modify Descriptor variable Values
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPatchWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    multiplexerIdx:multiplexerIdx
    sIGNALDEMULTIPLEXER1:sIGNALDEMULTIPLEXER1
              completionHandler: ^(SIGNAL_DEMULTIPLEXER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitDemultiplexerApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var multiplexerIdx = 0; // {Integer} Descriptor SIGNAL_DEMULTIPLEXER index

var opts = {
  'sIGNALDEMULTIPLEXER1': {SIGNAL_DEMULTIPLEXER={objectName=Demultiplexer 0}} // {SIGNALDEMULTIPLEXER1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPatch(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPatchExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitDemultiplexerApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var multiplexerIdx = 0;  // Integer | Descriptor SIGNAL_DEMULTIPLEXER index
 (default to null)
            var sIGNALDEMULTIPLEXER1 = new SIGNALDEMULTIPLEXER1(); // SIGNALDEMULTIPLEXER1 |  (optional) 

            try {
                // modify Descriptor variable Values
                SIGNAL_DEMULTIPLEXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPatch(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, sIGNALDEMULTIPLEXER1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitDemultiplexerApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitDemultiplexerApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$multiplexerIdx = 0; // Integer | Descriptor SIGNAL_DEMULTIPLEXER index

$sIGNALDEMULTIPLEXER1 = {SIGNAL_DEMULTIPLEXER={objectName=Demultiplexer 0}}; // SIGNALDEMULTIPLEXER1 | 

try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPatch($deviceId, $cfgIdx, $audioUnitIdx, $multiplexerIdx, $sIGNALDEMULTIPLEXER1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitDemultiplexerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitDemultiplexerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitDemultiplexerApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $multiplexerIdx = 0; # Integer | Descriptor SIGNAL_DEMULTIPLEXER index

my $sIGNALDEMULTIPLEXER1 = WWW::OPenAPIClient::Object::SIGNALDEMULTIPLEXER1->new(); # SIGNALDEMULTIPLEXER1 | 

eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPatch(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, multiplexerIdx => $multiplexerIdx, sIGNALDEMULTIPLEXER1 => $sIGNALDEMULTIPLEXER1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitDemultiplexerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPatch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitDemultiplexerApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
multiplexerIdx = 0 # Integer | Descriptor SIGNAL_DEMULTIPLEXER index
 (default to null)
sIGNALDEMULTIPLEXER1 = {SIGNAL_DEMULTIPLEXER={objectName=Demultiplexer 0}} # SIGNALDEMULTIPLEXER1 |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_demultiplexer_multiplexer_idx_patch(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, sIGNALDEMULTIPLEXER1=sIGNALDEMULTIPLEXER1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitDemultiplexerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPatch: %s\n" % e)
extern crate DescriptorsAudioUnitDemultiplexerApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let multiplexerIdx = 0; // Integer
    let sIGNALDEMULTIPLEXER1 = {SIGNAL_DEMULTIPLEXER={objectName=Demultiplexer 0}}; // SIGNALDEMULTIPLEXER1

    let mut context = DescriptorsAudioUnitDemultiplexerApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPatch(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, sIGNALDEMULTIPLEXER1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
multiplexer_idx*
Integer
Descriptor SIGNAL_DEMULTIPLEXER index
Required
Body parameters
Name Description
sIGNALDEMULTIPLEXER1

Set Object Name

Responses


v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPut

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/demultiplexer/{multiplexer_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/demultiplexer/{multiplexer_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitDemultiplexerApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitDemultiplexerApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitDemultiplexerApi apiInstance = new DescriptorsAudioUnitDemultiplexerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer multiplexerIdx = 0; // Integer | Descriptor SIGNAL_DEMULTIPLEXER index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            SIGNAL_DEMULTIPLEXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPut(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitDemultiplexerApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPut");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitDemultiplexerApi;

public class DescriptorsAudioUnitDemultiplexerApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitDemultiplexerApi apiInstance = new DescriptorsAudioUnitDemultiplexerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer multiplexerIdx = 0; // Integer | Descriptor SIGNAL_DEMULTIPLEXER index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            SIGNAL_DEMULTIPLEXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPut(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitDemultiplexerApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPut");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitDemultiplexerApi *apiInstance = [[DescriptorsAudioUnitDemultiplexerApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *multiplexerIdx = 0; // Descriptor SIGNAL_DEMULTIPLEXER index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPutWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    multiplexerIdx:multiplexerIdx
    length:length
    data:data
              completionHandler: ^(SIGNAL_DEMULTIPLEXER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitDemultiplexerApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var multiplexerIdx = 0; // {Integer} Descriptor SIGNAL_DEMULTIPLEXER index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPut(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPutExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitDemultiplexerApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var multiplexerIdx = 0;  // Integer | Descriptor SIGNAL_DEMULTIPLEXER index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                SIGNAL_DEMULTIPLEXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPut(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitDemultiplexerApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitDemultiplexerApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$multiplexerIdx = 0; // Integer | Descriptor SIGNAL_DEMULTIPLEXER index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPut($deviceId, $cfgIdx, $audioUnitIdx, $multiplexerIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitDemultiplexerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitDemultiplexerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitDemultiplexerApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $multiplexerIdx = 0; # Integer | Descriptor SIGNAL_DEMULTIPLEXER index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPut(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, multiplexerIdx => $multiplexerIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitDemultiplexerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitDemultiplexerApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
multiplexerIdx = 0 # Integer | Descriptor SIGNAL_DEMULTIPLEXER index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_demultiplexer_multiplexer_idx_put(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitDemultiplexerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPut: %s\n" % e)
extern crate DescriptorsAudioUnitDemultiplexerApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let multiplexerIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = DescriptorsAudioUnitDemultiplexerApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxDemultiplexerMultiplexerIdxPut(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
multiplexer_idx*
Integer
Descriptor SIGNAL_DEMULTIPLEXER index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


DescriptorsAudioUnitMatrix

v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxGet

Get Descriptor AudioUnit matrix


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/matrix/{matrix_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/matrix/{matrix_idx}?entity=®ion=&format="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitMatrixApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitMatrixApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitMatrixApi apiInstance = new DescriptorsAudioUnitMatrixApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer matrixIdx = 0; // Integer | Descriptor MATRIX index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        Region region = ; // Region | The **GET_MATRIX** command is used to get the current values of a Control point in the Matrix. 
It can be used to get the values of Matrix or a values of a subregion of a Matrix horizontally or vertically. 
The get_matrix command returns the values for the currently active Configuration.

        Format6 format = ; // Format6 | specific value Control Value 

        
        try {
            MATRIX result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxGet(deviceId, cfgIdx, audioUnitIdx, matrixIdx, entity, region, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitMatrixApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitMatrixApi;

public class DescriptorsAudioUnitMatrixApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitMatrixApi apiInstance = new DescriptorsAudioUnitMatrixApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer matrixIdx = 0; // Integer | Descriptor MATRIX index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        Region region = ; // Region | The **GET_MATRIX** command is used to get the current values of a Control point in the Matrix. 
It can be used to get the values of Matrix or a values of a subregion of a Matrix horizontally or vertically. 
The get_matrix command returns the values for the currently active Configuration.

        Format6 format = ; // Format6 | specific value Control Value 

        
        try {
            MATRIX result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxGet(deviceId, cfgIdx, audioUnitIdx, matrixIdx, entity, region, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitMatrixApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitMatrixApi *apiInstance = [[DescriptorsAudioUnitMatrixApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *matrixIdx = 0; // Descriptor MATRIX index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)
Region *region = ; // The **GET_MATRIX** command is used to get the current values of a Control point in the Matrix. 
It can be used to get the values of Matrix or a values of a subregion of a Matrix horizontally or vertically. 
The get_matrix command returns the values for the currently active Configuration.
 (optional) (default to null)
Format6 *format = ; // specific value Control Value 
 (optional) (default to null)

// Get Descriptor AudioUnit matrix
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxGetWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    matrixIdx:matrixIdx
    entity:entity
    region:region
    format:format
              completionHandler: ^(MATRIX output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitMatrixApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var matrixIdx = 0; // {Integer} Descriptor MATRIX index

var opts = {
  'entity': , // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

  'region': , // {Region} The **GET_MATRIX** command is used to get the current values of a Control point in the Matrix. 
It can be used to get the values of Matrix or a values of a subregion of a Matrix horizontally or vertically. 
The get_matrix command returns the values for the currently active Configuration.

  'format':  // {Format6} specific value Control Value 

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxGet(deviceId, cfgIdx, audioUnitIdx, matrixIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxGetExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitMatrixApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var matrixIdx = 0;  // Integer | Descriptor MATRIX index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional)  (default to null)
            var region = new Region(); // Region | The **GET_MATRIX** command is used to get the current values of a Control point in the Matrix. 
It can be used to get the values of Matrix or a values of a subregion of a Matrix horizontally or vertically. 
The get_matrix command returns the values for the currently active Configuration.
 (optional)  (default to null)
            var format = new Format6(); // Format6 | specific value Control Value 
 (optional)  (default to null)

            try {
                // Get Descriptor AudioUnit matrix
                MATRIX result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxGet(deviceId, cfgIdx, audioUnitIdx, matrixIdx, entity, region, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitMatrixApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitMatrixApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$matrixIdx = 0; // Integer | Descriptor MATRIX index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

$region = ; // Region | The **GET_MATRIX** command is used to get the current values of a Control point in the Matrix. 
It can be used to get the values of Matrix or a values of a subregion of a Matrix horizontally or vertically. 
The get_matrix command returns the values for the currently active Configuration.

$format = ; // Format6 | specific value Control Value 


try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxGet($deviceId, $cfgIdx, $audioUnitIdx, $matrixIdx, $entity, $region, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitMatrixApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitMatrixApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitMatrixApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $matrixIdx = 0; # Integer | Descriptor MATRIX index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

my $region = ; # Region | The **GET_MATRIX** command is used to get the current values of a Control point in the Matrix. 
It can be used to get the values of Matrix or a values of a subregion of a Matrix horizontally or vertically. 
The get_matrix command returns the values for the currently active Configuration.

my $format = ; # Format6 | specific value Control Value 


eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxGet(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, matrixIdx => $matrixIdx, entity => $entity, region => $region, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitMatrixApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitMatrixApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
matrixIdx = 0 # Integer | Descriptor MATRIX index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)
region =  # Region | The **GET_MATRIX** command is used to get the current values of a Control point in the Matrix. 
It can be used to get the values of Matrix or a values of a subregion of a Matrix horizontally or vertically. 
The get_matrix command returns the values for the currently active Configuration.
 (optional) (default to null)
format =  # Format6 | specific value Control Value 
 (optional) (default to null)

try: 
    # Get Descriptor AudioUnit matrix
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_matrix_matrix_idx_get(deviceId, cfgIdx, audioUnitIdx, matrixIdx, entity=entity, region=region, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitMatrixApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxGet: %s\n" % e)
extern crate DescriptorsAudioUnitMatrixApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let matrixIdx = 0; // Integer
    let entity = ; // array[String]
    let region = ; // Region
    let format = ; // Format6

    let mut context = DescriptorsAudioUnitMatrixApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxGet(deviceId, cfgIdx, audioUnitIdx, matrixIdx, entity, region, format, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
matrix_idx*
Integer
Descriptor MATRIX index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
region
Region
The **GET_MATRIX** command is used to get the current values of a Control point in the Matrix. It can be used to get the values of Matrix or a values of a subregion of a Matrix horizontally or vertically. The get_matrix command returns the values for the currently active Configuration.
format
Format6
specific value Control Value

Responses


v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPatch

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command. *region* The **SET_MATRIX** command acts on a MATRIX descriptor in the current Configuration. An Entity may propagate the Matrix value changes onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. It can be used to fill a Matrix or a subregion of a Matrix horizontally or vertically with: * The same repeating value * list of repeating values A list of non-repeating values * A list non-repeating values spanning more than one **SET_MATRIX** command


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/matrix/{matrix_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/matrix/{matrix_idx}?region="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitMatrixApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitMatrixApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitMatrixApi apiInstance = new DescriptorsAudioUnitMatrixApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer matrixIdx = 0; // Integer | Descriptor MATRIX index

        Region1 region = ; // Region1 | Set Matrix Control Values

        MATRIX1 mATRIX1 = {MATRIX={objectName=Matrix 0}}; // MATRIX1 | 
        
        try {
            MATRIX result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPatch(deviceId, cfgIdx, audioUnitIdx, matrixIdx, region, mATRIX1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitMatrixApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPatch");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitMatrixApi;

public class DescriptorsAudioUnitMatrixApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitMatrixApi apiInstance = new DescriptorsAudioUnitMatrixApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer matrixIdx = 0; // Integer | Descriptor MATRIX index

        Region1 region = ; // Region1 | Set Matrix Control Values

        MATRIX1 mATRIX1 = {MATRIX={objectName=Matrix 0}}; // MATRIX1 | 
        
        try {
            MATRIX result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPatch(deviceId, cfgIdx, audioUnitIdx, matrixIdx, region, mATRIX1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitMatrixApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPatch");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitMatrixApi *apiInstance = [[DescriptorsAudioUnitMatrixApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *matrixIdx = 0; // Descriptor MATRIX index
 (default to null)
Region1 *region = ; // Set Matrix Control Values
 (optional) (default to null)
MATRIX1 *mATRIX1 = {MATRIX={objectName=Matrix 0}}; //  (optional)

// modify Descriptor variable Values
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPatchWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    matrixIdx:matrixIdx
    region:region
    mATRIX1:mATRIX1
              completionHandler: ^(MATRIX output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitMatrixApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var matrixIdx = 0; // {Integer} Descriptor MATRIX index

var opts = {
  'region': , // {Region1} Set Matrix Control Values

  'mATRIX1': {MATRIX={objectName=Matrix 0}} // {MATRIX1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPatch(deviceId, cfgIdx, audioUnitIdx, matrixIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPatchExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitMatrixApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var matrixIdx = 0;  // Integer | Descriptor MATRIX index
 (default to null)
            var region = new Region1(); // Region1 | Set Matrix Control Values
 (optional)  (default to null)
            var mATRIX1 = new MATRIX1(); // MATRIX1 |  (optional) 

            try {
                // modify Descriptor variable Values
                MATRIX result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPatch(deviceId, cfgIdx, audioUnitIdx, matrixIdx, region, mATRIX1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitMatrixApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitMatrixApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$matrixIdx = 0; // Integer | Descriptor MATRIX index

$region = ; // Region1 | Set Matrix Control Values

$mATRIX1 = {MATRIX={objectName=Matrix 0}}; // MATRIX1 | 

try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPatch($deviceId, $cfgIdx, $audioUnitIdx, $matrixIdx, $region, $mATRIX1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitMatrixApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitMatrixApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitMatrixApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $matrixIdx = 0; # Integer | Descriptor MATRIX index

my $region = ; # Region1 | Set Matrix Control Values

my $mATRIX1 = WWW::OPenAPIClient::Object::MATRIX1->new(); # MATRIX1 | 

eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPatch(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, matrixIdx => $matrixIdx, region => $region, mATRIX1 => $mATRIX1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitMatrixApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPatch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitMatrixApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
matrixIdx = 0 # Integer | Descriptor MATRIX index
 (default to null)
region =  # Region1 | Set Matrix Control Values
 (optional) (default to null)
mATRIX1 = {MATRIX={objectName=Matrix 0}} # MATRIX1 |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_matrix_matrix_idx_patch(deviceId, cfgIdx, audioUnitIdx, matrixIdx, region=region, mATRIX1=mATRIX1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitMatrixApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPatch: %s\n" % e)
extern crate DescriptorsAudioUnitMatrixApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let matrixIdx = 0; // Integer
    let region = ; // Region1
    let mATRIX1 = {MATRIX={objectName=Matrix 0}}; // MATRIX1

    let mut context = DescriptorsAudioUnitMatrixApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPatch(deviceId, cfgIdx, audioUnitIdx, matrixIdx, region, mATRIX1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
matrix_idx*
Integer
Descriptor MATRIX index
Required
Body parameters
Name Description
mATRIX1

Set Object Name and Control Value

Query parameters
Name Description
region
Region1
Set Matrix Control Values

Responses


v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPut

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/matrix/{matrix_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/matrix/{matrix_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitMatrixApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitMatrixApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitMatrixApi apiInstance = new DescriptorsAudioUnitMatrixApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer matrixIdx = 0; // Integer | Descriptor MATRIX index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            MATRIX result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPut(deviceId, cfgIdx, audioUnitIdx, matrixIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitMatrixApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPut");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitMatrixApi;

public class DescriptorsAudioUnitMatrixApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitMatrixApi apiInstance = new DescriptorsAudioUnitMatrixApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer matrixIdx = 0; // Integer | Descriptor MATRIX index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            MATRIX result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPut(deviceId, cfgIdx, audioUnitIdx, matrixIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitMatrixApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPut");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitMatrixApi *apiInstance = [[DescriptorsAudioUnitMatrixApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *matrixIdx = 0; // Descriptor MATRIX index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPutWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    matrixIdx:matrixIdx
    length:length
    data:data
              completionHandler: ^(MATRIX output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitMatrixApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var matrixIdx = 0; // {Integer} Descriptor MATRIX index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPut(deviceId, cfgIdx, audioUnitIdx, matrixIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPutExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitMatrixApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var matrixIdx = 0;  // Integer | Descriptor MATRIX index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                MATRIX result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPut(deviceId, cfgIdx, audioUnitIdx, matrixIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitMatrixApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitMatrixApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$matrixIdx = 0; // Integer | Descriptor MATRIX index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPut($deviceId, $cfgIdx, $audioUnitIdx, $matrixIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitMatrixApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitMatrixApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitMatrixApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $matrixIdx = 0; # Integer | Descriptor MATRIX index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPut(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, matrixIdx => $matrixIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitMatrixApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitMatrixApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
matrixIdx = 0 # Integer | Descriptor MATRIX index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_matrix_matrix_idx_put(deviceId, cfgIdx, audioUnitIdx, matrixIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitMatrixApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPut: %s\n" % e)
extern crate DescriptorsAudioUnitMatrixApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let matrixIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = DescriptorsAudioUnitMatrixApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMatrixMatrixIdxPut(deviceId, cfgIdx, audioUnitIdx, matrixIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
matrix_idx*
Integer
Descriptor MATRIX index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


DescriptorsAudioUnitMixer

v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxGet

Get Descriptor AudioUnit mixer


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/mixer/{mixer_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/mixer/{mixer_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitMixerApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitMixerApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitMixerApi apiInstance = new DescriptorsAudioUnitMixerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer mixerIdx = 0; // Integer | Descriptor MIXER index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            MIXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxGet(deviceId, cfgIdx, audioUnitIdx, mixerIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitMixerApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitMixerApi;

public class DescriptorsAudioUnitMixerApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitMixerApi apiInstance = new DescriptorsAudioUnitMixerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer mixerIdx = 0; // Integer | Descriptor MIXER index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            MIXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxGet(deviceId, cfgIdx, audioUnitIdx, mixerIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitMixerApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitMixerApi *apiInstance = [[DescriptorsAudioUnitMixerApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *mixerIdx = 0; // Descriptor MIXER index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

// Get Descriptor AudioUnit mixer
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxGetWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    mixerIdx:mixerIdx
    entity:entity
              completionHandler: ^(MIXER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitMixerApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var mixerIdx = 0; // {Integer} Descriptor MIXER index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxGet(deviceId, cfgIdx, audioUnitIdx, mixerIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxGetExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitMixerApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var mixerIdx = 0;  // Integer | Descriptor MIXER index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional)  (default to null)

            try {
                // Get Descriptor AudioUnit mixer
                MIXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxGet(deviceId, cfgIdx, audioUnitIdx, mixerIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitMixerApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitMixerApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$mixerIdx = 0; // Integer | Descriptor MIXER index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxGet($deviceId, $cfgIdx, $audioUnitIdx, $mixerIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitMixerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitMixerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitMixerApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $mixerIdx = 0; # Integer | Descriptor MIXER index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxGet(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, mixerIdx => $mixerIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitMixerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitMixerApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
mixerIdx = 0 # Integer | Descriptor MIXER index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

try: 
    # Get Descriptor AudioUnit mixer
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_mixer_mixer_idx_get(deviceId, cfgIdx, audioUnitIdx, mixerIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitMixerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxGet: %s\n" % e)
extern crate DescriptorsAudioUnitMixerApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let mixerIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = DescriptorsAudioUnitMixerApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxGet(deviceId, cfgIdx, audioUnitIdx, mixerIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
mixer_idx*
Integer
Descriptor MIXER index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

Responses


v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPatch

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command. *value* The **SET_MIXER** command acts on a MIXER descriptor in the current Configuration. An AVDECC Entity may propagate the Memory Object value change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. The mixer mixes control signals from different sources. All sources have the same controlValueType. The parameters depend on the controlValueType, please look in the extended documentation for which parameters can be set. Alternatively, you can specify the format yourself, but this can lead to incorrect values.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/mixer/{mixer_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/mixer/{mixer_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitMixerApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitMixerApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitMixerApi apiInstance = new DescriptorsAudioUnitMixerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer mixerIdx = 0; // Integer | Descriptor MIXER index

        MIXER1 mIXER1 = {MIXER={objectName=Mixer 0}}; // MIXER1 | 
        
        try {
            MIXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPatch(deviceId, cfgIdx, audioUnitIdx, mixerIdx, mIXER1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitMixerApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPatch");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitMixerApi;

public class DescriptorsAudioUnitMixerApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitMixerApi apiInstance = new DescriptorsAudioUnitMixerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer mixerIdx = 0; // Integer | Descriptor MIXER index

        MIXER1 mIXER1 = {MIXER={objectName=Mixer 0}}; // MIXER1 | 
        
        try {
            MIXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPatch(deviceId, cfgIdx, audioUnitIdx, mixerIdx, mIXER1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitMixerApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPatch");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitMixerApi *apiInstance = [[DescriptorsAudioUnitMixerApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *mixerIdx = 0; // Descriptor MIXER index
 (default to null)
MIXER1 *mIXER1 = {MIXER={objectName=Mixer 0}}; //  (optional)

// modify Descriptor variable Values
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPatchWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    mixerIdx:mixerIdx
    mIXER1:mIXER1
              completionHandler: ^(MIXER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitMixerApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var mixerIdx = 0; // {Integer} Descriptor MIXER index

var opts = {
  'mIXER1': {MIXER={objectName=Mixer 0}} // {MIXER1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPatch(deviceId, cfgIdx, audioUnitIdx, mixerIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPatchExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitMixerApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var mixerIdx = 0;  // Integer | Descriptor MIXER index
 (default to null)
            var mIXER1 = new MIXER1(); // MIXER1 |  (optional) 

            try {
                // modify Descriptor variable Values
                MIXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPatch(deviceId, cfgIdx, audioUnitIdx, mixerIdx, mIXER1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitMixerApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitMixerApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$mixerIdx = 0; // Integer | Descriptor MIXER index

$mIXER1 = {MIXER={objectName=Mixer 0}}; // MIXER1 | 

try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPatch($deviceId, $cfgIdx, $audioUnitIdx, $mixerIdx, $mIXER1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitMixerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitMixerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitMixerApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $mixerIdx = 0; # Integer | Descriptor MIXER index

my $mIXER1 = WWW::OPenAPIClient::Object::MIXER1->new(); # MIXER1 | 

eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPatch(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, mixerIdx => $mixerIdx, mIXER1 => $mIXER1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitMixerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPatch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitMixerApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
mixerIdx = 0 # Integer | Descriptor MIXER index
 (default to null)
mIXER1 = {MIXER={objectName=Mixer 0}} # MIXER1 |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_mixer_mixer_idx_patch(deviceId, cfgIdx, audioUnitIdx, mixerIdx, mIXER1=mIXER1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitMixerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPatch: %s\n" % e)
extern crate DescriptorsAudioUnitMixerApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let mixerIdx = 0; // Integer
    let mIXER1 = {MIXER={objectName=Mixer 0}}; // MIXER1

    let mut context = DescriptorsAudioUnitMixerApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPatch(deviceId, cfgIdx, audioUnitIdx, mixerIdx, mIXER1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
mixer_idx*
Integer
Descriptor MIXER index
Required
Body parameters
Name Description
mIXER1

Set Object Name and Control Value

Responses


v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPut

Write Descriptor in device

The **WIRTE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/mixer/{mixer_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/mixer/{mixer_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitMixerApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitMixerApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitMixerApi apiInstance = new DescriptorsAudioUnitMixerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer mixerIdx = 0; // Integer | Descriptor MIXER index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            MIXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPut(deviceId, cfgIdx, audioUnitIdx, mixerIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitMixerApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPut");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitMixerApi;

public class DescriptorsAudioUnitMixerApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitMixerApi apiInstance = new DescriptorsAudioUnitMixerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer mixerIdx = 0; // Integer | Descriptor MIXER index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            MIXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPut(deviceId, cfgIdx, audioUnitIdx, mixerIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitMixerApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPut");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitMixerApi *apiInstance = [[DescriptorsAudioUnitMixerApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *mixerIdx = 0; // Descriptor MIXER index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPutWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    mixerIdx:mixerIdx
    length:length
    data:data
              completionHandler: ^(MIXER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitMixerApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var mixerIdx = 0; // {Integer} Descriptor MIXER index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPut(deviceId, cfgIdx, audioUnitIdx, mixerIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPutExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitMixerApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var mixerIdx = 0;  // Integer | Descriptor MIXER index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                MIXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPut(deviceId, cfgIdx, audioUnitIdx, mixerIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitMixerApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitMixerApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$mixerIdx = 0; // Integer | Descriptor MIXER index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPut($deviceId, $cfgIdx, $audioUnitIdx, $mixerIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitMixerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitMixerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitMixerApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $mixerIdx = 0; # Integer | Descriptor MIXER index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPut(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, mixerIdx => $mixerIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitMixerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitMixerApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
mixerIdx = 0 # Integer | Descriptor MIXER index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_mixer_mixer_idx_put(deviceId, cfgIdx, audioUnitIdx, mixerIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitMixerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPut: %s\n" % e)
extern crate DescriptorsAudioUnitMixerApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let mixerIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = DescriptorsAudioUnitMixerApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMixerMixerIdxPut(deviceId, cfgIdx, audioUnitIdx, mixerIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
mixer_idx*
Integer
Descriptor MIXER index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


DescriptorsAudioUnitMultiplexer

v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxGet

Get Descriptor AudioUnit multiplexer


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/multiplexer/{multiplexer_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/multiplexer/{multiplexer_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitMultiplexerApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitMultiplexerApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitMultiplexerApi apiInstance = new DescriptorsAudioUnitMultiplexerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer multiplexerIdx = 0; // Integer | Descriptor SIGNAL_MULTIPLEXER index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            SIGNAL_MULTIPLEXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxGet(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitMultiplexerApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitMultiplexerApi;

public class DescriptorsAudioUnitMultiplexerApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitMultiplexerApi apiInstance = new DescriptorsAudioUnitMultiplexerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer multiplexerIdx = 0; // Integer | Descriptor SIGNAL_MULTIPLEXER index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            SIGNAL_MULTIPLEXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxGet(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitMultiplexerApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitMultiplexerApi *apiInstance = [[DescriptorsAudioUnitMultiplexerApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *multiplexerIdx = 0; // Descriptor SIGNAL_MULTIPLEXER index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

// Get Descriptor AudioUnit multiplexer
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxGetWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    multiplexerIdx:multiplexerIdx
    entity:entity
              completionHandler: ^(SIGNAL_MULTIPLEXER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitMultiplexerApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var multiplexerIdx = 0; // {Integer} Descriptor SIGNAL_MULTIPLEXER index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxGet(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxGetExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitMultiplexerApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var multiplexerIdx = 0;  // Integer | Descriptor SIGNAL_MULTIPLEXER index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional)  (default to null)

            try {
                // Get Descriptor AudioUnit multiplexer
                SIGNAL_MULTIPLEXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxGet(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitMultiplexerApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitMultiplexerApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$multiplexerIdx = 0; // Integer | Descriptor SIGNAL_MULTIPLEXER index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxGet($deviceId, $cfgIdx, $audioUnitIdx, $multiplexerIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitMultiplexerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitMultiplexerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitMultiplexerApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $multiplexerIdx = 0; # Integer | Descriptor SIGNAL_MULTIPLEXER index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxGet(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, multiplexerIdx => $multiplexerIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitMultiplexerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitMultiplexerApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
multiplexerIdx = 0 # Integer | Descriptor SIGNAL_MULTIPLEXER index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

try: 
    # Get Descriptor AudioUnit multiplexer
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_multiplexer_multiplexer_idx_get(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitMultiplexerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxGet: %s\n" % e)
extern crate DescriptorsAudioUnitMultiplexerApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let multiplexerIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = DescriptorsAudioUnitMultiplexerApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxGet(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
multiplexer_idx*
Integer
Descriptor SIGNAL_MULTIPLEXER index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

Responses


v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPatch

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/multiplexer/{multiplexer_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/multiplexer/{multiplexer_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitMultiplexerApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitMultiplexerApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitMultiplexerApi apiInstance = new DescriptorsAudioUnitMultiplexerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer multiplexerIdx = 0; // Integer | Descriptor SIGNAL_MULTIPLEXER index

        SIGNALMULTIPLEXER1 sIGNALMULTIPLEXER1 = {SIGNAL_MULTIPLEXER={objectName=Multiplexer 0}}; // SIGNALMULTIPLEXER1 | 
        
        try {
            SIGNAL_MULTIPLEXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPatch(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, sIGNALMULTIPLEXER1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitMultiplexerApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPatch");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitMultiplexerApi;

public class DescriptorsAudioUnitMultiplexerApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitMultiplexerApi apiInstance = new DescriptorsAudioUnitMultiplexerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer multiplexerIdx = 0; // Integer | Descriptor SIGNAL_MULTIPLEXER index

        SIGNALMULTIPLEXER1 sIGNALMULTIPLEXER1 = {SIGNAL_MULTIPLEXER={objectName=Multiplexer 0}}; // SIGNALMULTIPLEXER1 | 
        
        try {
            SIGNAL_MULTIPLEXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPatch(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, sIGNALMULTIPLEXER1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitMultiplexerApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPatch");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitMultiplexerApi *apiInstance = [[DescriptorsAudioUnitMultiplexerApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *multiplexerIdx = 0; // Descriptor SIGNAL_MULTIPLEXER index
 (default to null)
SIGNALMULTIPLEXER1 *sIGNALMULTIPLEXER1 = {SIGNAL_MULTIPLEXER={objectName=Multiplexer 0}}; //  (optional)

// modify Descriptor variable Values
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPatchWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    multiplexerIdx:multiplexerIdx
    sIGNALMULTIPLEXER1:sIGNALMULTIPLEXER1
              completionHandler: ^(SIGNAL_MULTIPLEXER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitMultiplexerApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var multiplexerIdx = 0; // {Integer} Descriptor SIGNAL_MULTIPLEXER index

var opts = {
  'sIGNALMULTIPLEXER1': {SIGNAL_MULTIPLEXER={objectName=Multiplexer 0}} // {SIGNALMULTIPLEXER1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPatch(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPatchExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitMultiplexerApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var multiplexerIdx = 0;  // Integer | Descriptor SIGNAL_MULTIPLEXER index
 (default to null)
            var sIGNALMULTIPLEXER1 = new SIGNALMULTIPLEXER1(); // SIGNALMULTIPLEXER1 |  (optional) 

            try {
                // modify Descriptor variable Values
                SIGNAL_MULTIPLEXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPatch(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, sIGNALMULTIPLEXER1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitMultiplexerApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitMultiplexerApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$multiplexerIdx = 0; // Integer | Descriptor SIGNAL_MULTIPLEXER index

$sIGNALMULTIPLEXER1 = {SIGNAL_MULTIPLEXER={objectName=Multiplexer 0}}; // SIGNALMULTIPLEXER1 | 

try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPatch($deviceId, $cfgIdx, $audioUnitIdx, $multiplexerIdx, $sIGNALMULTIPLEXER1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitMultiplexerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitMultiplexerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitMultiplexerApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $multiplexerIdx = 0; # Integer | Descriptor SIGNAL_MULTIPLEXER index

my $sIGNALMULTIPLEXER1 = WWW::OPenAPIClient::Object::SIGNALMULTIPLEXER1->new(); # SIGNALMULTIPLEXER1 | 

eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPatch(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, multiplexerIdx => $multiplexerIdx, sIGNALMULTIPLEXER1 => $sIGNALMULTIPLEXER1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitMultiplexerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPatch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitMultiplexerApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
multiplexerIdx = 0 # Integer | Descriptor SIGNAL_MULTIPLEXER index
 (default to null)
sIGNALMULTIPLEXER1 = {SIGNAL_MULTIPLEXER={objectName=Multiplexer 0}} # SIGNALMULTIPLEXER1 |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_multiplexer_multiplexer_idx_patch(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, sIGNALMULTIPLEXER1=sIGNALMULTIPLEXER1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitMultiplexerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPatch: %s\n" % e)
extern crate DescriptorsAudioUnitMultiplexerApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let multiplexerIdx = 0; // Integer
    let sIGNALMULTIPLEXER1 = {SIGNAL_MULTIPLEXER={objectName=Multiplexer 0}}; // SIGNALMULTIPLEXER1

    let mut context = DescriptorsAudioUnitMultiplexerApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPatch(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, sIGNALMULTIPLEXER1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
multiplexer_idx*
Integer
Descriptor SIGNAL_MULTIPLEXER index
Required
Body parameters
Name Description
sIGNALMULTIPLEXER1

Set Object Name

Responses


v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPut

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/multiplexer/{multiplexer_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/multiplexer/{multiplexer_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitMultiplexerApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitMultiplexerApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitMultiplexerApi apiInstance = new DescriptorsAudioUnitMultiplexerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer multiplexerIdx = 0; // Integer | Descriptor SIGNAL_MULTIPLEXER index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            SIGNAL_DEMULTIPLEXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPut(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitMultiplexerApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPut");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitMultiplexerApi;

public class DescriptorsAudioUnitMultiplexerApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitMultiplexerApi apiInstance = new DescriptorsAudioUnitMultiplexerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer multiplexerIdx = 0; // Integer | Descriptor SIGNAL_MULTIPLEXER index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            SIGNAL_DEMULTIPLEXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPut(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitMultiplexerApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPut");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitMultiplexerApi *apiInstance = [[DescriptorsAudioUnitMultiplexerApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *multiplexerIdx = 0; // Descriptor SIGNAL_MULTIPLEXER index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPutWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    multiplexerIdx:multiplexerIdx
    length:length
    data:data
              completionHandler: ^(SIGNAL_DEMULTIPLEXER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitMultiplexerApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var multiplexerIdx = 0; // {Integer} Descriptor SIGNAL_MULTIPLEXER index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPut(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPutExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitMultiplexerApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var multiplexerIdx = 0;  // Integer | Descriptor SIGNAL_MULTIPLEXER index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                SIGNAL_DEMULTIPLEXER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPut(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitMultiplexerApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitMultiplexerApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$multiplexerIdx = 0; // Integer | Descriptor SIGNAL_MULTIPLEXER index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPut($deviceId, $cfgIdx, $audioUnitIdx, $multiplexerIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitMultiplexerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitMultiplexerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitMultiplexerApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $multiplexerIdx = 0; # Integer | Descriptor SIGNAL_MULTIPLEXER index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPut(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, multiplexerIdx => $multiplexerIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitMultiplexerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitMultiplexerApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
multiplexerIdx = 0 # Integer | Descriptor SIGNAL_MULTIPLEXER index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_multiplexer_multiplexer_idx_put(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitMultiplexerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPut: %s\n" % e)
extern crate DescriptorsAudioUnitMultiplexerApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let multiplexerIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = DescriptorsAudioUnitMultiplexerApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxMultiplexerMultiplexerIdxPut(deviceId, cfgIdx, audioUnitIdx, multiplexerIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
multiplexer_idx*
Integer
Descriptor SIGNAL_MULTIPLEXER index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


DescriptorsAudioUnitSignalCombiner

v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxGet

Get Descriptor AudioUnit signal Combiner


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/signalCombiner/{combiner_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/signalCombiner/{combiner_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitSignalCombinerApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitSignalCombinerApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitSignalCombinerApi apiInstance = new DescriptorsAudioUnitSignalCombinerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer combinerIdx = 0; // Integer | Descriptor SIGNAL_COMBINER index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            SIGNAL_COMBINER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxGet(deviceId, cfgIdx, audioUnitIdx, combinerIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitSignalCombinerApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitSignalCombinerApi;

public class DescriptorsAudioUnitSignalCombinerApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitSignalCombinerApi apiInstance = new DescriptorsAudioUnitSignalCombinerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer combinerIdx = 0; // Integer | Descriptor SIGNAL_COMBINER index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            SIGNAL_COMBINER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxGet(deviceId, cfgIdx, audioUnitIdx, combinerIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitSignalCombinerApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitSignalCombinerApi *apiInstance = [[DescriptorsAudioUnitSignalCombinerApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *combinerIdx = 0; // Descriptor SIGNAL_COMBINER index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

// Get Descriptor AudioUnit signal Combiner
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxGetWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    combinerIdx:combinerIdx
    entity:entity
              completionHandler: ^(SIGNAL_COMBINER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitSignalCombinerApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var combinerIdx = 0; // {Integer} Descriptor SIGNAL_COMBINER index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxGet(deviceId, cfgIdx, audioUnitIdx, combinerIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxGetExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitSignalCombinerApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var combinerIdx = 0;  // Integer | Descriptor SIGNAL_COMBINER index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional)  (default to null)

            try {
                // Get Descriptor AudioUnit signal Combiner
                SIGNAL_COMBINER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxGet(deviceId, cfgIdx, audioUnitIdx, combinerIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitSignalCombinerApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitSignalCombinerApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$combinerIdx = 0; // Integer | Descriptor SIGNAL_COMBINER index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxGet($deviceId, $cfgIdx, $audioUnitIdx, $combinerIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitSignalCombinerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitSignalCombinerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitSignalCombinerApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $combinerIdx = 0; # Integer | Descriptor SIGNAL_COMBINER index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxGet(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, combinerIdx => $combinerIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitSignalCombinerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitSignalCombinerApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
combinerIdx = 0 # Integer | Descriptor SIGNAL_COMBINER index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

try: 
    # Get Descriptor AudioUnit signal Combiner
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_signal_combiner_combiner_idx_get(deviceId, cfgIdx, audioUnitIdx, combinerIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitSignalCombinerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxGet: %s\n" % e)
extern crate DescriptorsAudioUnitSignalCombinerApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let combinerIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = DescriptorsAudioUnitSignalCombinerApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxGet(deviceId, cfgIdx, audioUnitIdx, combinerIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
combiner_idx*
Integer
Descriptor SIGNAL_COMBINER index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

Responses


v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPatch

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/signalCombiner/{combiner_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/signalCombiner/{combiner_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitSignalCombinerApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitSignalCombinerApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitSignalCombinerApi apiInstance = new DescriptorsAudioUnitSignalCombinerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer combinerIdx = 0; // Integer | Descriptor SIGNAL_COMBINER index

        SIGNALCOMBINER1 sIGNALCOMBINER1 = {SIGNAL_COMBINER={objectName=Combiner 0}}; // SIGNALCOMBINER1 | 
        
        try {
            SIGNAL_COMBINER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPatch(deviceId, cfgIdx, audioUnitIdx, combinerIdx, sIGNALCOMBINER1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitSignalCombinerApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPatch");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitSignalCombinerApi;

public class DescriptorsAudioUnitSignalCombinerApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitSignalCombinerApi apiInstance = new DescriptorsAudioUnitSignalCombinerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer combinerIdx = 0; // Integer | Descriptor SIGNAL_COMBINER index

        SIGNALCOMBINER1 sIGNALCOMBINER1 = {SIGNAL_COMBINER={objectName=Combiner 0}}; // SIGNALCOMBINER1 | 
        
        try {
            SIGNAL_COMBINER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPatch(deviceId, cfgIdx, audioUnitIdx, combinerIdx, sIGNALCOMBINER1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitSignalCombinerApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPatch");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitSignalCombinerApi *apiInstance = [[DescriptorsAudioUnitSignalCombinerApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *combinerIdx = 0; // Descriptor SIGNAL_COMBINER index
 (default to null)
SIGNALCOMBINER1 *sIGNALCOMBINER1 = {SIGNAL_COMBINER={objectName=Combiner 0}}; //  (optional)

// modify Descriptor variable Values
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPatchWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    combinerIdx:combinerIdx
    sIGNALCOMBINER1:sIGNALCOMBINER1
              completionHandler: ^(SIGNAL_COMBINER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitSignalCombinerApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var combinerIdx = 0; // {Integer} Descriptor SIGNAL_COMBINER index

var opts = {
  'sIGNALCOMBINER1': {SIGNAL_COMBINER={objectName=Combiner 0}} // {SIGNALCOMBINER1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPatch(deviceId, cfgIdx, audioUnitIdx, combinerIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPatchExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitSignalCombinerApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var combinerIdx = 0;  // Integer | Descriptor SIGNAL_COMBINER index
 (default to null)
            var sIGNALCOMBINER1 = new SIGNALCOMBINER1(); // SIGNALCOMBINER1 |  (optional) 

            try {
                // modify Descriptor variable Values
                SIGNAL_COMBINER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPatch(deviceId, cfgIdx, audioUnitIdx, combinerIdx, sIGNALCOMBINER1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitSignalCombinerApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitSignalCombinerApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$combinerIdx = 0; // Integer | Descriptor SIGNAL_COMBINER index

$sIGNALCOMBINER1 = {SIGNAL_COMBINER={objectName=Combiner 0}}; // SIGNALCOMBINER1 | 

try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPatch($deviceId, $cfgIdx, $audioUnitIdx, $combinerIdx, $sIGNALCOMBINER1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitSignalCombinerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitSignalCombinerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitSignalCombinerApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $combinerIdx = 0; # Integer | Descriptor SIGNAL_COMBINER index

my $sIGNALCOMBINER1 = WWW::OPenAPIClient::Object::SIGNALCOMBINER1->new(); # SIGNALCOMBINER1 | 

eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPatch(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, combinerIdx => $combinerIdx, sIGNALCOMBINER1 => $sIGNALCOMBINER1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitSignalCombinerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPatch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitSignalCombinerApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
combinerIdx = 0 # Integer | Descriptor SIGNAL_COMBINER index
 (default to null)
sIGNALCOMBINER1 = {SIGNAL_COMBINER={objectName=Combiner 0}} # SIGNALCOMBINER1 |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_signal_combiner_combiner_idx_patch(deviceId, cfgIdx, audioUnitIdx, combinerIdx, sIGNALCOMBINER1=sIGNALCOMBINER1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitSignalCombinerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPatch: %s\n" % e)
extern crate DescriptorsAudioUnitSignalCombinerApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let combinerIdx = 0; // Integer
    let sIGNALCOMBINER1 = {SIGNAL_COMBINER={objectName=Combiner 0}}; // SIGNALCOMBINER1

    let mut context = DescriptorsAudioUnitSignalCombinerApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPatch(deviceId, cfgIdx, audioUnitIdx, combinerIdx, sIGNALCOMBINER1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
combiner_idx*
Integer
Descriptor SIGNAL_COMBINER index
Required
Body parameters
Name Description
sIGNALCOMBINER1

Set Object Name

Responses


v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPut

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/signalCombiner/{combiner_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/signalCombiner/{combiner_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitSignalCombinerApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitSignalCombinerApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitSignalCombinerApi apiInstance = new DescriptorsAudioUnitSignalCombinerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer combinerIdx = 0; // Integer | Descriptor SIGNAL_COMBINER index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            SIGNAL_COMBINER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPut(deviceId, cfgIdx, audioUnitIdx, combinerIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitSignalCombinerApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPut");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitSignalCombinerApi;

public class DescriptorsAudioUnitSignalCombinerApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitSignalCombinerApi apiInstance = new DescriptorsAudioUnitSignalCombinerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer combinerIdx = 0; // Integer | Descriptor SIGNAL_COMBINER index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            SIGNAL_COMBINER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPut(deviceId, cfgIdx, audioUnitIdx, combinerIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitSignalCombinerApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPut");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitSignalCombinerApi *apiInstance = [[DescriptorsAudioUnitSignalCombinerApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *combinerIdx = 0; // Descriptor SIGNAL_COMBINER index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPutWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    combinerIdx:combinerIdx
    length:length
    data:data
              completionHandler: ^(SIGNAL_COMBINER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitSignalCombinerApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var combinerIdx = 0; // {Integer} Descriptor SIGNAL_COMBINER index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPut(deviceId, cfgIdx, audioUnitIdx, combinerIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPutExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitSignalCombinerApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var combinerIdx = 0;  // Integer | Descriptor SIGNAL_COMBINER index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                SIGNAL_COMBINER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPut(deviceId, cfgIdx, audioUnitIdx, combinerIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitSignalCombinerApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitSignalCombinerApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$combinerIdx = 0; // Integer | Descriptor SIGNAL_COMBINER index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPut($deviceId, $cfgIdx, $audioUnitIdx, $combinerIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitSignalCombinerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitSignalCombinerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitSignalCombinerApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $combinerIdx = 0; # Integer | Descriptor SIGNAL_COMBINER index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPut(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, combinerIdx => $combinerIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitSignalCombinerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitSignalCombinerApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
combinerIdx = 0 # Integer | Descriptor SIGNAL_COMBINER index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_signal_combiner_combiner_idx_put(deviceId, cfgIdx, audioUnitIdx, combinerIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitSignalCombinerApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPut: %s\n" % e)
extern crate DescriptorsAudioUnitSignalCombinerApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let combinerIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = DescriptorsAudioUnitSignalCombinerApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalCombinerCombinerIdxPut(deviceId, cfgIdx, audioUnitIdx, combinerIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
combiner_idx*
Integer
Descriptor SIGNAL_COMBINER index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


DescriptorsAudioUnitSignalSelector

v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxGet

Get Descriptor AudioUnit signalSelector


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/signalSelector/{selector_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/signalSelector/{selector_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitSignalSelectorApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitSignalSelectorApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitSignalSelectorApi apiInstance = new DescriptorsAudioUnitSignalSelectorApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer selectorIdx = 0; // Integer | Descriptor SIGNAL_SELECTOR index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*currentSignal* The **GET_SIGNAL_SELECTOR** command is used to get the current source of a Signal Selector Control. 
The get_signal_selector command returns the source of a Signal Selector for the currently active Configuration.

        
        try {
            SIGNAL_SELECTOR result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxGet(deviceId, cfgIdx, audioUnitIdx, selectorIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitSignalSelectorApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitSignalSelectorApi;

public class DescriptorsAudioUnitSignalSelectorApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitSignalSelectorApi apiInstance = new DescriptorsAudioUnitSignalSelectorApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer selectorIdx = 0; // Integer | Descriptor SIGNAL_SELECTOR index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*currentSignal* The **GET_SIGNAL_SELECTOR** command is used to get the current source of a Signal Selector Control. 
The get_signal_selector command returns the source of a Signal Selector for the currently active Configuration.

        
        try {
            SIGNAL_SELECTOR result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxGet(deviceId, cfgIdx, audioUnitIdx, selectorIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitSignalSelectorApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitSignalSelectorApi *apiInstance = [[DescriptorsAudioUnitSignalSelectorApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *selectorIdx = 0; // Descriptor SIGNAL_SELECTOR index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*currentSignal* The **GET_SIGNAL_SELECTOR** command is used to get the current source of a Signal Selector Control. 
The get_signal_selector command returns the source of a Signal Selector for the currently active Configuration.
 (optional) (default to null)

// Get Descriptor AudioUnit signalSelector
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxGetWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    selectorIdx:selectorIdx
    entity:entity
              completionHandler: ^(SIGNAL_SELECTOR output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitSignalSelectorApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var selectorIdx = 0; // {Integer} Descriptor SIGNAL_SELECTOR index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*currentSignal* The **GET_SIGNAL_SELECTOR** command is used to get the current source of a Signal Selector Control. 
The get_signal_selector command returns the source of a Signal Selector for the currently active Configuration.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxGet(deviceId, cfgIdx, audioUnitIdx, selectorIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxGetExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitSignalSelectorApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var selectorIdx = 0;  // Integer | Descriptor SIGNAL_SELECTOR index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*currentSignal* The **GET_SIGNAL_SELECTOR** command is used to get the current source of a Signal Selector Control. 
The get_signal_selector command returns the source of a Signal Selector for the currently active Configuration.
 (optional)  (default to null)

            try {
                // Get Descriptor AudioUnit signalSelector
                SIGNAL_SELECTOR result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxGet(deviceId, cfgIdx, audioUnitIdx, selectorIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitSignalSelectorApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitSignalSelectorApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$selectorIdx = 0; // Integer | Descriptor SIGNAL_SELECTOR index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*currentSignal* The **GET_SIGNAL_SELECTOR** command is used to get the current source of a Signal Selector Control. 
The get_signal_selector command returns the source of a Signal Selector for the currently active Configuration.


try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxGet($deviceId, $cfgIdx, $audioUnitIdx, $selectorIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitSignalSelectorApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitSignalSelectorApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitSignalSelectorApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $selectorIdx = 0; # Integer | Descriptor SIGNAL_SELECTOR index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*currentSignal* The **GET_SIGNAL_SELECTOR** command is used to get the current source of a Signal Selector Control. 
The get_signal_selector command returns the source of a Signal Selector for the currently active Configuration.


eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxGet(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, selectorIdx => $selectorIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitSignalSelectorApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitSignalSelectorApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
selectorIdx = 0 # Integer | Descriptor SIGNAL_SELECTOR index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*currentSignal* The **GET_SIGNAL_SELECTOR** command is used to get the current source of a Signal Selector Control. 
The get_signal_selector command returns the source of a Signal Selector for the currently active Configuration.
 (optional) (default to null)

try: 
    # Get Descriptor AudioUnit signalSelector
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_signal_selector_selector_idx_get(deviceId, cfgIdx, audioUnitIdx, selectorIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitSignalSelectorApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxGet: %s\n" % e)
extern crate DescriptorsAudioUnitSignalSelectorApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let selectorIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = DescriptorsAudioUnitSignalSelectorApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxGet(deviceId, cfgIdx, audioUnitIdx, selectorIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
selector_idx*
Integer
Descriptor SIGNAL_SELECTOR index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on. *currentSignal* The **GET_SIGNAL_SELECTOR** command is used to get the current source of a Signal Selector Control. The get_signal_selector command returns the source of a Signal Selector for the currently active Configuration.

Responses


v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPatch

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command. *currentSignal* The **SET_SIGNAL_SELECTOR** command is used to change the signal source of a Signal Selector Control. The set_signal_selector command acts on a SIGNAL_SELECTOR descriptor in the current Configuration. An AVDECC Entity may propagate the selection change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. For valid values, please refer to the descriptor.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/signalSelector/{selector_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/signalSelector/{selector_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitSignalSelectorApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitSignalSelectorApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitSignalSelectorApi apiInstance = new DescriptorsAudioUnitSignalSelectorApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer selectorIdx = 0; // Integer | Descriptor SIGNAL_SELECTOR index

        SIGNALSELECTOR1 sIGNALSELECTOR1 = {SIGNAL_SELECTOR={objectName=Selector 0}}; // SIGNALSELECTOR1 | 
        
        try {
            SIGNAL_SELECTOR result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPatch(deviceId, cfgIdx, audioUnitIdx, selectorIdx, sIGNALSELECTOR1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitSignalSelectorApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPatch");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitSignalSelectorApi;

public class DescriptorsAudioUnitSignalSelectorApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitSignalSelectorApi apiInstance = new DescriptorsAudioUnitSignalSelectorApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer selectorIdx = 0; // Integer | Descriptor SIGNAL_SELECTOR index

        SIGNALSELECTOR1 sIGNALSELECTOR1 = {SIGNAL_SELECTOR={objectName=Selector 0}}; // SIGNALSELECTOR1 | 
        
        try {
            SIGNAL_SELECTOR result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPatch(deviceId, cfgIdx, audioUnitIdx, selectorIdx, sIGNALSELECTOR1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitSignalSelectorApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPatch");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitSignalSelectorApi *apiInstance = [[DescriptorsAudioUnitSignalSelectorApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *selectorIdx = 0; // Descriptor SIGNAL_SELECTOR index
 (default to null)
SIGNALSELECTOR1 *sIGNALSELECTOR1 = {SIGNAL_SELECTOR={objectName=Selector 0}}; //  (optional)

// modify Descriptor variable Values
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPatchWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    selectorIdx:selectorIdx
    sIGNALSELECTOR1:sIGNALSELECTOR1
              completionHandler: ^(SIGNAL_SELECTOR output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitSignalSelectorApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var selectorIdx = 0; // {Integer} Descriptor SIGNAL_SELECTOR index

var opts = {
  'sIGNALSELECTOR1': {SIGNAL_SELECTOR={objectName=Selector 0}} // {SIGNALSELECTOR1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPatch(deviceId, cfgIdx, audioUnitIdx, selectorIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPatchExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitSignalSelectorApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var selectorIdx = 0;  // Integer | Descriptor SIGNAL_SELECTOR index
 (default to null)
            var sIGNALSELECTOR1 = new SIGNALSELECTOR1(); // SIGNALSELECTOR1 |  (optional) 

            try {
                // modify Descriptor variable Values
                SIGNAL_SELECTOR result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPatch(deviceId, cfgIdx, audioUnitIdx, selectorIdx, sIGNALSELECTOR1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitSignalSelectorApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitSignalSelectorApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$selectorIdx = 0; // Integer | Descriptor SIGNAL_SELECTOR index

$sIGNALSELECTOR1 = {SIGNAL_SELECTOR={objectName=Selector 0}}; // SIGNALSELECTOR1 | 

try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPatch($deviceId, $cfgIdx, $audioUnitIdx, $selectorIdx, $sIGNALSELECTOR1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitSignalSelectorApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitSignalSelectorApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitSignalSelectorApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $selectorIdx = 0; # Integer | Descriptor SIGNAL_SELECTOR index

my $sIGNALSELECTOR1 = WWW::OPenAPIClient::Object::SIGNALSELECTOR1->new(); # SIGNALSELECTOR1 | 

eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPatch(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, selectorIdx => $selectorIdx, sIGNALSELECTOR1 => $sIGNALSELECTOR1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitSignalSelectorApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPatch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitSignalSelectorApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
selectorIdx = 0 # Integer | Descriptor SIGNAL_SELECTOR index
 (default to null)
sIGNALSELECTOR1 = {SIGNAL_SELECTOR={objectName=Selector 0}} # SIGNALSELECTOR1 |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_signal_selector_selector_idx_patch(deviceId, cfgIdx, audioUnitIdx, selectorIdx, sIGNALSELECTOR1=sIGNALSELECTOR1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitSignalSelectorApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPatch: %s\n" % e)
extern crate DescriptorsAudioUnitSignalSelectorApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let selectorIdx = 0; // Integer
    let sIGNALSELECTOR1 = {SIGNAL_SELECTOR={objectName=Selector 0}}; // SIGNALSELECTOR1

    let mut context = DescriptorsAudioUnitSignalSelectorApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPatch(deviceId, cfgIdx, audioUnitIdx, selectorIdx, sIGNALSELECTOR1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
selector_idx*
Integer
Descriptor SIGNAL_SELECTOR index
Required
Body parameters
Name Description
sIGNALSELECTOR1

Patch variable Values

Responses


v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPut

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/signalSelector/{selector_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/signalSelector/{selector_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitSignalSelectorApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitSignalSelectorApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitSignalSelectorApi apiInstance = new DescriptorsAudioUnitSignalSelectorApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer selectorIdx = 0; // Integer | Descriptor SIGNAL_SELECTOR index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            SIGNAL_SELECTOR result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPut(deviceId, cfgIdx, audioUnitIdx, selectorIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitSignalSelectorApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPut");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitSignalSelectorApi;

public class DescriptorsAudioUnitSignalSelectorApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitSignalSelectorApi apiInstance = new DescriptorsAudioUnitSignalSelectorApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer selectorIdx = 0; // Integer | Descriptor SIGNAL_SELECTOR index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            SIGNAL_SELECTOR result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPut(deviceId, cfgIdx, audioUnitIdx, selectorIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitSignalSelectorApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPut");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitSignalSelectorApi *apiInstance = [[DescriptorsAudioUnitSignalSelectorApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *selectorIdx = 0; // Descriptor SIGNAL_SELECTOR index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPutWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    selectorIdx:selectorIdx
    length:length
    data:data
              completionHandler: ^(SIGNAL_SELECTOR output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitSignalSelectorApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var selectorIdx = 0; // {Integer} Descriptor SIGNAL_SELECTOR index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPut(deviceId, cfgIdx, audioUnitIdx, selectorIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPutExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitSignalSelectorApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var selectorIdx = 0;  // Integer | Descriptor SIGNAL_SELECTOR index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                SIGNAL_SELECTOR result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPut(deviceId, cfgIdx, audioUnitIdx, selectorIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitSignalSelectorApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitSignalSelectorApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$selectorIdx = 0; // Integer | Descriptor SIGNAL_SELECTOR index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPut($deviceId, $cfgIdx, $audioUnitIdx, $selectorIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitSignalSelectorApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitSignalSelectorApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitSignalSelectorApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $selectorIdx = 0; # Integer | Descriptor SIGNAL_SELECTOR index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPut(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, selectorIdx => $selectorIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitSignalSelectorApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitSignalSelectorApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
selectorIdx = 0 # Integer | Descriptor SIGNAL_SELECTOR index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_signal_selector_selector_idx_put(deviceId, cfgIdx, audioUnitIdx, selectorIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitSignalSelectorApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPut: %s\n" % e)
extern crate DescriptorsAudioUnitSignalSelectorApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let selectorIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = DescriptorsAudioUnitSignalSelectorApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSelectorSelectorIdxPut(deviceId, cfgIdx, audioUnitIdx, selectorIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
selector_idx*
Integer
Descriptor SIGNAL_SELECTOR index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


DescriptorsAudioUnitSignalSplitter

v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxGet

Get Descriptor AudioUnit signal Splitter


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/signalSplitter/{splitter_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/signalSplitter/{splitter_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitSignalSplitterApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitSignalSplitterApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitSignalSplitterApi apiInstance = new DescriptorsAudioUnitSignalSplitterApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer splitterIdx = 0; // Integer | Descriptor SIGNAL_SPLITTER index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            SIGNAL_SPLITTER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxGet(deviceId, cfgIdx, audioUnitIdx, splitterIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitSignalSplitterApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitSignalSplitterApi;

public class DescriptorsAudioUnitSignalSplitterApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitSignalSplitterApi apiInstance = new DescriptorsAudioUnitSignalSplitterApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer splitterIdx = 0; // Integer | Descriptor SIGNAL_SPLITTER index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            SIGNAL_SPLITTER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxGet(deviceId, cfgIdx, audioUnitIdx, splitterIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitSignalSplitterApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitSignalSplitterApi *apiInstance = [[DescriptorsAudioUnitSignalSplitterApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *splitterIdx = 0; // Descriptor SIGNAL_SPLITTER index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

// Get Descriptor AudioUnit signal Splitter
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxGetWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    splitterIdx:splitterIdx
    entity:entity
              completionHandler: ^(SIGNAL_SPLITTER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitSignalSplitterApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var splitterIdx = 0; // {Integer} Descriptor SIGNAL_SPLITTER index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxGet(deviceId, cfgIdx, audioUnitIdx, splitterIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxGetExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitSignalSplitterApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var splitterIdx = 0;  // Integer | Descriptor SIGNAL_SPLITTER index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional)  (default to null)

            try {
                // Get Descriptor AudioUnit signal Splitter
                SIGNAL_SPLITTER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxGet(deviceId, cfgIdx, audioUnitIdx, splitterIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitSignalSplitterApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitSignalSplitterApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$splitterIdx = 0; // Integer | Descriptor SIGNAL_SPLITTER index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxGet($deviceId, $cfgIdx, $audioUnitIdx, $splitterIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitSignalSplitterApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitSignalSplitterApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitSignalSplitterApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $splitterIdx = 0; # Integer | Descriptor SIGNAL_SPLITTER index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxGet(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, splitterIdx => $splitterIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitSignalSplitterApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitSignalSplitterApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
splitterIdx = 0 # Integer | Descriptor SIGNAL_SPLITTER index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

try: 
    # Get Descriptor AudioUnit signal Splitter
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_signal_splitter_splitter_idx_get(deviceId, cfgIdx, audioUnitIdx, splitterIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitSignalSplitterApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxGet: %s\n" % e)
extern crate DescriptorsAudioUnitSignalSplitterApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let splitterIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = DescriptorsAudioUnitSignalSplitterApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxGet(deviceId, cfgIdx, audioUnitIdx, splitterIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
splitter_idx*
Integer
Descriptor SIGNAL_SPLITTER index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

Responses


v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPatch

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/signalSplitter/{splitter_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/signalSplitter/{splitter_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitSignalSplitterApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitSignalSplitterApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitSignalSplitterApi apiInstance = new DescriptorsAudioUnitSignalSplitterApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer splitterIdx = 0; // Integer | Descriptor SIGNAL_SPLITTER index

        SIGNALSPLITTER1 sIGNALSPLITTER1 = {SIGNAL_SPLITTER={objectName=Splitter 0}}; // SIGNALSPLITTER1 | 
        
        try {
            SIGNAL_SPLITTER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPatch(deviceId, cfgIdx, audioUnitIdx, splitterIdx, sIGNALSPLITTER1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitSignalSplitterApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPatch");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitSignalSplitterApi;

public class DescriptorsAudioUnitSignalSplitterApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitSignalSplitterApi apiInstance = new DescriptorsAudioUnitSignalSplitterApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer splitterIdx = 0; // Integer | Descriptor SIGNAL_SPLITTER index

        SIGNALSPLITTER1 sIGNALSPLITTER1 = {SIGNAL_SPLITTER={objectName=Splitter 0}}; // SIGNALSPLITTER1 | 
        
        try {
            SIGNAL_SPLITTER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPatch(deviceId, cfgIdx, audioUnitIdx, splitterIdx, sIGNALSPLITTER1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitSignalSplitterApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPatch");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitSignalSplitterApi *apiInstance = [[DescriptorsAudioUnitSignalSplitterApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *splitterIdx = 0; // Descriptor SIGNAL_SPLITTER index
 (default to null)
SIGNALSPLITTER1 *sIGNALSPLITTER1 = {SIGNAL_SPLITTER={objectName=Splitter 0}}; //  (optional)

// modify Descriptor variable Values
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPatchWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    splitterIdx:splitterIdx
    sIGNALSPLITTER1:sIGNALSPLITTER1
              completionHandler: ^(SIGNAL_SPLITTER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitSignalSplitterApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var splitterIdx = 0; // {Integer} Descriptor SIGNAL_SPLITTER index

var opts = {
  'sIGNALSPLITTER1': {SIGNAL_SPLITTER={objectName=Splitter 0}} // {SIGNALSPLITTER1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPatch(deviceId, cfgIdx, audioUnitIdx, splitterIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPatchExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitSignalSplitterApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var splitterIdx = 0;  // Integer | Descriptor SIGNAL_SPLITTER index
 (default to null)
            var sIGNALSPLITTER1 = new SIGNALSPLITTER1(); // SIGNALSPLITTER1 |  (optional) 

            try {
                // modify Descriptor variable Values
                SIGNAL_SPLITTER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPatch(deviceId, cfgIdx, audioUnitIdx, splitterIdx, sIGNALSPLITTER1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitSignalSplitterApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitSignalSplitterApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$splitterIdx = 0; // Integer | Descriptor SIGNAL_SPLITTER index

$sIGNALSPLITTER1 = {SIGNAL_SPLITTER={objectName=Splitter 0}}; // SIGNALSPLITTER1 | 

try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPatch($deviceId, $cfgIdx, $audioUnitIdx, $splitterIdx, $sIGNALSPLITTER1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitSignalSplitterApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitSignalSplitterApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitSignalSplitterApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $splitterIdx = 0; # Integer | Descriptor SIGNAL_SPLITTER index

my $sIGNALSPLITTER1 = WWW::OPenAPIClient::Object::SIGNALSPLITTER1->new(); # SIGNALSPLITTER1 | 

eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPatch(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, splitterIdx => $splitterIdx, sIGNALSPLITTER1 => $sIGNALSPLITTER1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitSignalSplitterApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPatch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitSignalSplitterApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
splitterIdx = 0 # Integer | Descriptor SIGNAL_SPLITTER index
 (default to null)
sIGNALSPLITTER1 = {SIGNAL_SPLITTER={objectName=Splitter 0}} # SIGNALSPLITTER1 |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_signal_splitter_splitter_idx_patch(deviceId, cfgIdx, audioUnitIdx, splitterIdx, sIGNALSPLITTER1=sIGNALSPLITTER1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitSignalSplitterApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPatch: %s\n" % e)
extern crate DescriptorsAudioUnitSignalSplitterApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let splitterIdx = 0; // Integer
    let sIGNALSPLITTER1 = {SIGNAL_SPLITTER={objectName=Splitter 0}}; // SIGNALSPLITTER1

    let mut context = DescriptorsAudioUnitSignalSplitterApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPatch(deviceId, cfgIdx, audioUnitIdx, splitterIdx, sIGNALSPLITTER1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
splitter_idx*
Integer
Descriptor SIGNAL_SPLITTER index
Required
Body parameters
Name Description
sIGNALSPLITTER1

Set Object Name

Responses


v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPut

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/signalSplitter/{splitter_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/signalSplitter/{splitter_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitSignalSplitterApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitSignalSplitterApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitSignalSplitterApi apiInstance = new DescriptorsAudioUnitSignalSplitterApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer splitterIdx = 0; // Integer | Descriptor SIGNAL_SPLITTER index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            SIGNAL_SPLITTER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPut(deviceId, cfgIdx, audioUnitIdx, splitterIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitSignalSplitterApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPut");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitSignalSplitterApi;

public class DescriptorsAudioUnitSignalSplitterApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitSignalSplitterApi apiInstance = new DescriptorsAudioUnitSignalSplitterApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer splitterIdx = 0; // Integer | Descriptor SIGNAL_SPLITTER index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            SIGNAL_SPLITTER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPut(deviceId, cfgIdx, audioUnitIdx, splitterIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitSignalSplitterApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPut");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitSignalSplitterApi *apiInstance = [[DescriptorsAudioUnitSignalSplitterApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *splitterIdx = 0; // Descriptor SIGNAL_SPLITTER index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPutWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    splitterIdx:splitterIdx
    length:length
    data:data
              completionHandler: ^(SIGNAL_SPLITTER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitSignalSplitterApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var splitterIdx = 0; // {Integer} Descriptor SIGNAL_SPLITTER index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPut(deviceId, cfgIdx, audioUnitIdx, splitterIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPutExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitSignalSplitterApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var splitterIdx = 0;  // Integer | Descriptor SIGNAL_SPLITTER index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                SIGNAL_SPLITTER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPut(deviceId, cfgIdx, audioUnitIdx, splitterIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitSignalSplitterApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitSignalSplitterApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$splitterIdx = 0; // Integer | Descriptor SIGNAL_SPLITTER index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPut($deviceId, $cfgIdx, $audioUnitIdx, $splitterIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitSignalSplitterApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitSignalSplitterApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitSignalSplitterApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $splitterIdx = 0; # Integer | Descriptor SIGNAL_SPLITTER index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPut(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, splitterIdx => $splitterIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitSignalSplitterApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitSignalSplitterApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
splitterIdx = 0 # Integer | Descriptor SIGNAL_SPLITTER index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_signal_splitter_splitter_idx_put(deviceId, cfgIdx, audioUnitIdx, splitterIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitSignalSplitterApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPut: %s\n" % e)
extern crate DescriptorsAudioUnitSignalSplitterApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let splitterIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = DescriptorsAudioUnitSignalSplitterApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxSignalSplitterSplitterIdxPut(deviceId, cfgIdx, audioUnitIdx, splitterIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
splitter_idx*
Integer
Descriptor SIGNAL_SPLITTER index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


DescriptorsAudioUnitTranscoder

v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxGet

Get Descriptor AudioUnit transcoder


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/transcoder/{transcoder_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/transcoder/{transcoder_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitTranscoderApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitTranscoderApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitTranscoderApi apiInstance = new DescriptorsAudioUnitTranscoderApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer transcoderIdx = 0; // Integer | Descriptor SIGNAL_TRANSCODER index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            SIGNAL_TRANSCODER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxGet(deviceId, cfgIdx, audioUnitIdx, transcoderIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitTranscoderApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitTranscoderApi;

public class DescriptorsAudioUnitTranscoderApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitTranscoderApi apiInstance = new DescriptorsAudioUnitTranscoderApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer transcoderIdx = 0; // Integer | Descriptor SIGNAL_TRANSCODER index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            SIGNAL_TRANSCODER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxGet(deviceId, cfgIdx, audioUnitIdx, transcoderIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitTranscoderApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitTranscoderApi *apiInstance = [[DescriptorsAudioUnitTranscoderApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *transcoderIdx = 0; // Descriptor SIGNAL_TRANSCODER index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

// Get Descriptor AudioUnit transcoder
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxGetWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    transcoderIdx:transcoderIdx
    entity:entity
              completionHandler: ^(SIGNAL_TRANSCODER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitTranscoderApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var transcoderIdx = 0; // {Integer} Descriptor SIGNAL_TRANSCODER index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxGet(deviceId, cfgIdx, audioUnitIdx, transcoderIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxGetExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitTranscoderApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var transcoderIdx = 0;  // Integer | Descriptor SIGNAL_TRANSCODER index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional)  (default to null)

            try {
                // Get Descriptor AudioUnit transcoder
                SIGNAL_TRANSCODER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxGet(deviceId, cfgIdx, audioUnitIdx, transcoderIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitTranscoderApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitTranscoderApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$transcoderIdx = 0; // Integer | Descriptor SIGNAL_TRANSCODER index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxGet($deviceId, $cfgIdx, $audioUnitIdx, $transcoderIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitTranscoderApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitTranscoderApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitTranscoderApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $transcoderIdx = 0; # Integer | Descriptor SIGNAL_TRANSCODER index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxGet(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, transcoderIdx => $transcoderIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitTranscoderApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitTranscoderApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
transcoderIdx = 0 # Integer | Descriptor SIGNAL_TRANSCODER index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

try: 
    # Get Descriptor AudioUnit transcoder
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_transcoder_transcoder_idx_get(deviceId, cfgIdx, audioUnitIdx, transcoderIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitTranscoderApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxGet: %s\n" % e)
extern crate DescriptorsAudioUnitTranscoderApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let transcoderIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = DescriptorsAudioUnitTranscoderApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxGet(deviceId, cfgIdx, audioUnitIdx, transcoderIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
transcoder_idx*
Integer
Descriptor SIGNAL_TRANSCODER index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

Responses


v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPatch

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/transcoder/{transcoder_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/transcoder/{transcoder_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitTranscoderApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitTranscoderApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitTranscoderApi apiInstance = new DescriptorsAudioUnitTranscoderApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer transcoderIdx = 0; // Integer | Descriptor SIGNAL_TRANSCODER index

        SIGNALTRANSCODER1 sIGNALTRANSCODER1 = {SIGNAL_TRANSCODER={objectName=Transcoder 0}}; // SIGNALTRANSCODER1 | 
        
        try {
            SIGNAL_TRANSCODER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPatch(deviceId, cfgIdx, audioUnitIdx, transcoderIdx, sIGNALTRANSCODER1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitTranscoderApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPatch");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitTranscoderApi;

public class DescriptorsAudioUnitTranscoderApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitTranscoderApi apiInstance = new DescriptorsAudioUnitTranscoderApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer transcoderIdx = 0; // Integer | Descriptor SIGNAL_TRANSCODER index

        SIGNALTRANSCODER1 sIGNALTRANSCODER1 = {SIGNAL_TRANSCODER={objectName=Transcoder 0}}; // SIGNALTRANSCODER1 | 
        
        try {
            SIGNAL_TRANSCODER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPatch(deviceId, cfgIdx, audioUnitIdx, transcoderIdx, sIGNALTRANSCODER1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitTranscoderApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPatch");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitTranscoderApi *apiInstance = [[DescriptorsAudioUnitTranscoderApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *transcoderIdx = 0; // Descriptor SIGNAL_TRANSCODER index
 (default to null)
SIGNALTRANSCODER1 *sIGNALTRANSCODER1 = {SIGNAL_TRANSCODER={objectName=Transcoder 0}}; //  (optional)

// modify Descriptor variable Values
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPatchWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    transcoderIdx:transcoderIdx
    sIGNALTRANSCODER1:sIGNALTRANSCODER1
              completionHandler: ^(SIGNAL_TRANSCODER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitTranscoderApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var transcoderIdx = 0; // {Integer} Descriptor SIGNAL_TRANSCODER index

var opts = {
  'sIGNALTRANSCODER1': {SIGNAL_TRANSCODER={objectName=Transcoder 0}} // {SIGNALTRANSCODER1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPatch(deviceId, cfgIdx, audioUnitIdx, transcoderIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPatchExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitTranscoderApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var transcoderIdx = 0;  // Integer | Descriptor SIGNAL_TRANSCODER index
 (default to null)
            var sIGNALTRANSCODER1 = new SIGNALTRANSCODER1(); // SIGNALTRANSCODER1 |  (optional) 

            try {
                // modify Descriptor variable Values
                SIGNAL_TRANSCODER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPatch(deviceId, cfgIdx, audioUnitIdx, transcoderIdx, sIGNALTRANSCODER1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitTranscoderApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitTranscoderApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$transcoderIdx = 0; // Integer | Descriptor SIGNAL_TRANSCODER index

$sIGNALTRANSCODER1 = {SIGNAL_TRANSCODER={objectName=Transcoder 0}}; // SIGNALTRANSCODER1 | 

try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPatch($deviceId, $cfgIdx, $audioUnitIdx, $transcoderIdx, $sIGNALTRANSCODER1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitTranscoderApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitTranscoderApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitTranscoderApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $transcoderIdx = 0; # Integer | Descriptor SIGNAL_TRANSCODER index

my $sIGNALTRANSCODER1 = WWW::OPenAPIClient::Object::SIGNALTRANSCODER1->new(); # SIGNALTRANSCODER1 | 

eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPatch(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, transcoderIdx => $transcoderIdx, sIGNALTRANSCODER1 => $sIGNALTRANSCODER1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitTranscoderApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPatch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitTranscoderApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
transcoderIdx = 0 # Integer | Descriptor SIGNAL_TRANSCODER index
 (default to null)
sIGNALTRANSCODER1 = {SIGNAL_TRANSCODER={objectName=Transcoder 0}} # SIGNALTRANSCODER1 |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_transcoder_transcoder_idx_patch(deviceId, cfgIdx, audioUnitIdx, transcoderIdx, sIGNALTRANSCODER1=sIGNALTRANSCODER1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitTranscoderApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPatch: %s\n" % e)
extern crate DescriptorsAudioUnitTranscoderApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let transcoderIdx = 0; // Integer
    let sIGNALTRANSCODER1 = {SIGNAL_TRANSCODER={objectName=Transcoder 0}}; // SIGNALTRANSCODER1

    let mut context = DescriptorsAudioUnitTranscoderApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPatch(deviceId, cfgIdx, audioUnitIdx, transcoderIdx, sIGNALTRANSCODER1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
transcoder_idx*
Integer
Descriptor SIGNAL_TRANSCODER index
Required
Body parameters
Name Description
sIGNALTRANSCODER1

Set Object Name

Responses


v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPut

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/transcoder/{transcoder_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/audioUnit/{audioUnit_idx}/transcoder/{transcoder_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DescriptorsAudioUnitTranscoderApi;

import java.io.File;
import java.util.*;

public class DescriptorsAudioUnitTranscoderApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DescriptorsAudioUnitTranscoderApi apiInstance = new DescriptorsAudioUnitTranscoderApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer transcoderIdx = 0; // Integer | Descriptor SIGNAL_TRANSCODER index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            SIGNAL_TRANSCODER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPut(deviceId, cfgIdx, audioUnitIdx, transcoderIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitTranscoderApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPut");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DescriptorsAudioUnitTranscoderApi;

public class DescriptorsAudioUnitTranscoderApiExample {
    public static void main(String[] args) {
        DescriptorsAudioUnitTranscoderApi apiInstance = new DescriptorsAudioUnitTranscoderApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

        Integer transcoderIdx = 0; // Integer | Descriptor SIGNAL_TRANSCODER index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            SIGNAL_TRANSCODER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPut(deviceId, cfgIdx, audioUnitIdx, transcoderIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorsAudioUnitTranscoderApi#v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPut");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DescriptorsAudioUnitTranscoderApi *apiInstance = [[DescriptorsAudioUnitTranscoderApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *audioUnitIdx = 0; // Descriptor AUDIO_UNIT index
 (default to null)
Integer *transcoderIdx = 0; // Descriptor SIGNAL_TRANSCODER index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPutWith:deviceId
    cfgIdx:cfgIdx
    audioUnitIdx:audioUnitIdx
    transcoderIdx:transcoderIdx
    length:length
    data:data
              completionHandler: ^(SIGNAL_TRANSCODER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DescriptorsAudioUnitTranscoderApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var audioUnitIdx = 0; // {Integer} Descriptor AUDIO_UNIT index

var transcoderIdx = 0; // {Integer} Descriptor SIGNAL_TRANSCODER index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPut(deviceId, cfgIdx, audioUnitIdx, transcoderIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPutExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DescriptorsAudioUnitTranscoderApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var audioUnitIdx = 0;  // Integer | Descriptor AUDIO_UNIT index
 (default to null)
            var transcoderIdx = 0;  // Integer | Descriptor SIGNAL_TRANSCODER index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                SIGNAL_TRANSCODER result = apiInstance.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPut(deviceId, cfgIdx, audioUnitIdx, transcoderIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DescriptorsAudioUnitTranscoderApi.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DescriptorsAudioUnitTranscoderApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$audioUnitIdx = 0; // Integer | Descriptor AUDIO_UNIT index

$transcoderIdx = 0; // Integer | Descriptor SIGNAL_TRANSCODER index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPut($deviceId, $cfgIdx, $audioUnitIdx, $transcoderIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorsAudioUnitTranscoderApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DescriptorsAudioUnitTranscoderApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DescriptorsAudioUnitTranscoderApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $audioUnitIdx = 0; # Integer | Descriptor AUDIO_UNIT index

my $transcoderIdx = 0; # Integer | Descriptor SIGNAL_TRANSCODER index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPut(deviceId => $deviceId, cfgIdx => $cfgIdx, audioUnitIdx => $audioUnitIdx, transcoderIdx => $transcoderIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorsAudioUnitTranscoderApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DescriptorsAudioUnitTranscoderApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
audioUnitIdx = 0 # Integer | Descriptor AUDIO_UNIT index
 (default to null)
transcoderIdx = 0 # Integer | Descriptor SIGNAL_TRANSCODER index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.v10_devices_device_id_descriptor_entity_configuration_cfg_idx_audio_unit_audio_unit_idx_transcoder_transcoder_idx_put(deviceId, cfgIdx, audioUnitIdx, transcoderIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorsAudioUnitTranscoderApi->v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPut: %s\n" % e)
extern crate DescriptorsAudioUnitTranscoderApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let audioUnitIdx = 0; // Integer
    let transcoderIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = DescriptorsAudioUnitTranscoderApi::Context::default();
    let result = client.v10DevicesDeviceIdDescriptorEntityConfigurationCfgIdxAudioUnitAudioUnitIdxTranscoderTranscoderIdxPut(deviceId, cfgIdx, audioUnitIdx, transcoderIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
audioUnit_idx*
Integer
Descriptor AUDIO_UNIT index
Required
transcoder_idx*
Integer
Descriptor SIGNAL_TRANSCODER index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


DeviceInterface

delDevices

Send AVB "DISCOVER" and find new devices


/v1.0/devices

Usage and SDK Samples

curl -X DELETE\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DeviceInterfaceApi;

import java.io.File;
import java.util.*;

public class DeviceInterfaceApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DeviceInterfaceApi apiInstance = new DeviceInterfaceApi();
        
        try {
            inline_response_200_3 result = apiInstance.delDevices();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceInterfaceApi#delDevices");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DeviceInterfaceApi;

public class DeviceInterfaceApiExample {
    public static void main(String[] args) {
        DeviceInterfaceApi apiInstance = new DeviceInterfaceApi();
        
        try {
            inline_response_200_3 result = apiInstance.delDevices();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceInterfaceApi#delDevices");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DeviceInterfaceApi *apiInstance = [[DeviceInterfaceApi alloc] init];

// Send AVB "DISCOVER" and find new devices
[apiInstance delDevicesWithCompletionHandler: 
              ^(inline_response_200_3 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DeviceInterfaceApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.delDevices(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class delDevicesExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DeviceInterfaceApi();

            try {
                // Send AVB "DISCOVER" and find new devices
                inline_response_200_3 result = apiInstance.delDevices();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DeviceInterfaceApi.delDevices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DeviceInterfaceApi();

try {
    $result = $api_instance->delDevices();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeviceInterfaceApi->delDevices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DeviceInterfaceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DeviceInterfaceApi->new();

eval { 
    my $result = $api_instance->delDevices();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeviceInterfaceApi->delDevices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DeviceInterfaceApi()

try: 
    # Send AVB "DISCOVER" and find new devices
    api_response = api_instance.del_devices()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceInterfaceApi->delDevices: %s\n" % e)
extern crate DeviceInterfaceApi;

pub fn main() {

    let mut context = DeviceInterfaceApi::Context::default();
    let result = client.delDevices(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getDevicePath

List all Device commands


/v1.0/devices/{deviceId}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DeviceInterfaceApi;

import java.io.File;
import java.util.*;

public class DeviceInterfaceApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DeviceInterfaceApi apiInstance = new DeviceInterfaceApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identfier

        
        try {
            inline_response_200_4 result = apiInstance.getDevicePath(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceInterfaceApi#getDevicePath");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DeviceInterfaceApi;

public class DeviceInterfaceApiExample {
    public static void main(String[] args) {
        DeviceInterfaceApi apiInstance = new DeviceInterfaceApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identfier

        
        try {
            inline_response_200_4 result = apiInstance.getDevicePath(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceInterfaceApi#getDevicePath");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DeviceInterfaceApi *apiInstance = [[DeviceInterfaceApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identfier
 (default to null)

// List all Device commands
[apiInstance getDevicePathWith:deviceId
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DeviceInterfaceApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identfier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDevicePath(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDevicePathExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DeviceInterfaceApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identfier
 (default to null)

            try {
                // List all Device commands
                inline_response_200_4 result = apiInstance.getDevicePath(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DeviceInterfaceApi.getDevicePath: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DeviceInterfaceApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identfier


try {
    $result = $api_instance->getDevicePath($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeviceInterfaceApi->getDevicePath: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DeviceInterfaceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DeviceInterfaceApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identfier


eval { 
    my $result = $api_instance->getDevicePath(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeviceInterfaceApi->getDevicePath: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DeviceInterfaceApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identfier
 (default to null)

try: 
    # List all Device commands
    api_response = api_instance.get_device_path(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceInterfaceApi->getDevicePath: %s\n" % e)
extern crate DeviceInterfaceApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = DeviceInterfaceApi::Context::default();
    let result = client.getDevicePath(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identfier
Required

Responses


getDevices

List all discoverd devices


/v1.0/devices

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DeviceInterfaceApi;

import java.io.File;
import java.util.*;

public class DeviceInterfaceApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DeviceInterfaceApi apiInstance = new DeviceInterfaceApi();
        
        try {
            inline_response_200_2 result = apiInstance.getDevices();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceInterfaceApi#getDevices");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DeviceInterfaceApi;

public class DeviceInterfaceApiExample {
    public static void main(String[] args) {
        DeviceInterfaceApi apiInstance = new DeviceInterfaceApi();
        
        try {
            inline_response_200_2 result = apiInstance.getDevices();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceInterfaceApi#getDevices");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DeviceInterfaceApi *apiInstance = [[DeviceInterfaceApi alloc] init];

// List all discoverd devices
[apiInstance getDevicesWithCompletionHandler: 
              ^(inline_response_200_2 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DeviceInterfaceApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDevices(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDevicesExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DeviceInterfaceApi();

            try {
                // List all discoverd devices
                inline_response_200_2 result = apiInstance.getDevices();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DeviceInterfaceApi.getDevices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DeviceInterfaceApi();

try {
    $result = $api_instance->getDevices();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeviceInterfaceApi->getDevices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DeviceInterfaceApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DeviceInterfaceApi->new();

eval { 
    my $result = $api_instance->getDevices();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeviceInterfaceApi->getDevices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DeviceInterfaceApi()

try: 
    # List all discoverd devices
    api_response = api_instance.get_devices()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceInterfaceApi->getDevices: %s\n" % e)
extern crate DeviceInterfaceApi;

pub fn main() {

    let mut context = DeviceInterfaceApi::Context::default();
    let result = client.getDevices(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


Discovery

getDiscovery

Get ADP discovery data


/v1.0/devices/{deviceId}/discovery

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/discovery"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscoveryApi;

import java.io.File;
import java.util.*;

public class DiscoveryApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        DiscoveryApi apiInstance = new DiscoveryApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identfier

        
        try {
            discovery result = apiInstance.getDiscovery(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryApi#getDiscovery");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DiscoveryApi;

public class DiscoveryApiExample {
    public static void main(String[] args) {
        DiscoveryApi apiInstance = new DiscoveryApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identfier

        
        try {
            discovery result = apiInstance.getDiscovery(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryApi#getDiscovery");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DiscoveryApi *apiInstance = [[DiscoveryApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identfier
 (default to null)

// Get ADP discovery data
[apiInstance getDiscoveryWith:deviceId
              completionHandler: ^(discovery output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.DiscoveryApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identfier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDiscovery(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDiscoveryExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new DiscoveryApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identfier
 (default to null)

            try {
                // Get ADP discovery data
                discovery result = apiInstance.getDiscovery(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscoveryApi.getDiscovery: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscoveryApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identfier


try {
    $result = $api_instance->getDiscovery($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryApi->getDiscovery: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DiscoveryApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscoveryApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identfier


eval { 
    my $result = $api_instance->getDiscovery(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DiscoveryApi->getDiscovery: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DiscoveryApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identfier
 (default to null)

try: 
    # Get ADP discovery data
    api_response = api_instance.get_discovery(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscoveryApi->getDiscovery: %s\n" % e)
extern crate DiscoveryApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = DiscoveryApi::Context::default();
    let result = client.getDiscovery(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identfier
Required

Responses


Entity

acquireDescEntity

Authenticate to Entity

The **ACQUIRE** command is used by Controller to obtain exclusive access to an entire Entity or sub-tree objects. It also functions as a long-term lock on the entire entity or a sub-tree of objects. Most do not support sub-trees and The flag persistent is only supported if the flag AEM_PERSISTENT_ACQUIRE_SUPPORTED is law on the ADP discovery entity Capabilities field. Milan devices do not support the command.


/v1.0/devices/{deviceId}/descriptor/entity/acquire

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/acquire"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityApi;

import java.io.File;
import java.util.*;

public class EntityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        EntityApi apiInstance = new EntityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        String flags = flags_example; // String | 
        
        try {
            inline_response_200_9 result = apiInstance.acquireDescEntity(deviceId, flags);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityApi#acquireDescEntity");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EntityApi;

public class EntityApiExample {
    public static void main(String[] args) {
        EntityApi apiInstance = new EntityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        String flags = flags_example; // String | 
        
        try {
            inline_response_200_9 result = apiInstance.acquireDescEntity(deviceId, flags);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityApi#acquireDescEntity");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityApi *apiInstance = [[EntityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
String *flags = flags_example; //  (default to null)

// Authenticate to Entity
[apiInstance acquireDescEntityWith:deviceId
    flags:flags
              completionHandler: ^(inline_response_200_9 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.EntityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var flags = flags_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.acquireDescEntity(deviceId, flags, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class acquireDescEntityExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new EntityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var flags = flags_example;  // String |  (default to null)

            try {
                // Authenticate to Entity
                inline_response_200_9 result = apiInstance.acquireDescEntity(deviceId, flags);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityApi.acquireDescEntity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$flags = flags_example; // String | 

try {
    $result = $api_instance->acquireDescEntity($deviceId, $flags);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntityApi->acquireDescEntity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $flags = flags_example; # String | 

eval { 
    my $result = $api_instance->acquireDescEntity(deviceId => $deviceId, flags => $flags);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntityApi->acquireDescEntity: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
flags = flags_example # String |  (default to null)

try: 
    # Authenticate to Entity
    api_response = api_instance.acquire_desc_entity(deviceId, flags)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityApi->acquireDescEntity: %s\n" % e)
extern crate EntityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let flags = flags_example; // String

    let mut context = EntityApi::Context::default();
    let result = client.acquireDescEntity(deviceId, flags, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
Form parameters
Name Description
flags*
String
Enum: acquire, persistent, release
Required

Responses


authDescEntity

Authenticate to Entity

The **AUTHENTICATE** command is used to authenticate an Controller with an Entity.


/v1.0/devices/{deviceId}/descriptor/entity/authenticate

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/authenticate"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityApi;

import java.io.File;
import java.util.*;

public class EntityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        EntityApi apiInstance = new EntityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        InlineObject2 inlineObject2 = ; // InlineObject2 | 
        
        try {
            inline_response_200_8 result = apiInstance.authDescEntity(deviceId, inlineObject2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityApi#authDescEntity");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EntityApi;

public class EntityApiExample {
    public static void main(String[] args) {
        EntityApi apiInstance = new EntityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        InlineObject2 inlineObject2 = ; // InlineObject2 | 
        
        try {
            inline_response_200_8 result = apiInstance.authDescEntity(deviceId, inlineObject2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityApi#authDescEntity");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityApi *apiInstance = [[EntityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
InlineObject2 *inlineObject2 = ; //  (optional)

// Authenticate to Entity
[apiInstance authDescEntityWith:deviceId
    inlineObject2:inlineObject2
              completionHandler: ^(inline_response_200_8 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.EntityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var opts = {
  'inlineObject2':  // {InlineObject2} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.authDescEntity(deviceId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class authDescEntityExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new EntityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var inlineObject2 = new InlineObject2(); // InlineObject2 |  (optional) 

            try {
                // Authenticate to Entity
                inline_response_200_8 result = apiInstance.authDescEntity(deviceId, inlineObject2);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityApi.authDescEntity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$inlineObject2 = ; // InlineObject2 | 

try {
    $result = $api_instance->authDescEntity($deviceId, $inlineObject2);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntityApi->authDescEntity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $inlineObject2 = WWW::OPenAPIClient::Object::InlineObject2->new(); # InlineObject2 | 

eval { 
    my $result = $api_instance->authDescEntity(deviceId => $deviceId, inlineObject2 => $inlineObject2);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntityApi->authDescEntity: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
inlineObject2 =  # InlineObject2 |  (optional)

try: 
    # Authenticate to Entity
    api_response = api_instance.auth_desc_entity(deviceId, inlineObject2=inlineObject2)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityApi->authDescEntity: %s\n" % e)
extern crate EntityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let inlineObject2 = ; // InlineObject2

    let mut context = EntityApi::Context::default();
    let result = client.authDescEntity(deviceId, inlineObject2, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
Body parameters
Name Description
inlineObject2

Responses


countersDescEntity

Get Counters from Descriptor Entity

The **GET_COUNTERS** command is used to get the performance variables and diagnostics counters. The answer is descriptor specific, see extended documentation.


/v1.0/devices/{deviceId}/descriptor/entity/counters

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/counters"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityApi;

import java.io.File;
import java.util.*;

public class EntityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        EntityApi apiInstance = new EntityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_6 result = apiInstance.countersDescEntity(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityApi#countersDescEntity");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EntityApi;

public class EntityApiExample {
    public static void main(String[] args) {
        EntityApi apiInstance = new EntityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_6 result = apiInstance.countersDescEntity(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityApi#countersDescEntity");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityApi *apiInstance = [[EntityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)

// Get Counters from Descriptor Entity
[apiInstance countersDescEntityWith:deviceId
              completionHandler: ^(inline_response_200_6 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.EntityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.countersDescEntity(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class countersDescEntityExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new EntityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)

            try {
                // Get Counters from Descriptor Entity
                inline_response_200_6 result = apiInstance.countersDescEntity(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityApi.countersDescEntity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier


try {
    $result = $api_instance->countersDescEntity($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntityApi->countersDescEntity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier


eval { 
    my $result = $api_instance->countersDescEntity(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntityApi->countersDescEntity: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)

try: 
    # Get Counters from Descriptor Entity
    api_response = api_instance.counters_desc_entity(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityApi->countersDescEntity: %s\n" % e)
extern crate EntityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = EntityApi::Context::default();
    let result = client.countersDescEntity(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required

Responses


deauthDescEntity

Deauthenticate to Entity

The **DEAUTHENTICATE** command is used to deauthenticate an Controller with an Entity.


/v1.0/devices/{deviceId}/descriptor/entity/authenticate

Usage and SDK Samples

curl -X DELETE\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/authenticate"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityApi;

import java.io.File;
import java.util.*;

public class EntityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        EntityApi apiInstance = new EntityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_8 result = apiInstance.deauthDescEntity(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityApi#deauthDescEntity");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EntityApi;

public class EntityApiExample {
    public static void main(String[] args) {
        EntityApi apiInstance = new EntityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_8 result = apiInstance.deauthDescEntity(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityApi#deauthDescEntity");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityApi *apiInstance = [[EntityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)

// Deauthenticate to Entity
[apiInstance deauthDescEntityWith:deviceId
              completionHandler: ^(inline_response_200_8 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.EntityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deauthDescEntity(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deauthDescEntityExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new EntityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)

            try {
                // Deauthenticate to Entity
                inline_response_200_8 result = apiInstance.deauthDescEntity(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityApi.deauthDescEntity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier


try {
    $result = $api_instance->deauthDescEntity($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntityApi->deauthDescEntity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier


eval { 
    my $result = $api_instance->deauthDescEntity(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntityApi->deauthDescEntity: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)

try: 
    # Deauthenticate to Entity
    api_response = api_instance.deauth_desc_entity(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityApi->deauthDescEntity: %s\n" % e)
extern crate EntityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = EntityApi::Context::default();
    let result = client.deauthDescEntity(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required

Responses


getDescEntity

Get descriptor ENTITY from Database or device

Get Descriptor type Entity


/v1.0/devices/{deviceId}/descriptor/entity

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityApi;

import java.io.File;
import java.util.*;

public class EntityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        EntityApi apiInstance = new EntityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*entityName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*groupName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*associationId* ** The **GET_ASSOCIAtION_ID** command is used to get the value of the association id for the Entity.

*currentConfiguration* The **GET_CONFIGURATION** command is used to get the current Configuration of the Entity. 

        
        try {
            ENTITY result = apiInstance.getDescEntity(deviceId, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityApi#getDescEntity");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EntityApi;

public class EntityApiExample {
    public static void main(String[] args) {
        EntityApi apiInstance = new EntityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*entityName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*groupName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*associationId* ** The **GET_ASSOCIAtION_ID** command is used to get the value of the association id for the Entity.

*currentConfiguration* The **GET_CONFIGURATION** command is used to get the current Configuration of the Entity. 

        
        try {
            ENTITY result = apiInstance.getDescEntity(deviceId, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityApi#getDescEntity");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityApi *apiInstance = [[EntityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*entityName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*groupName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*associationId* ** The **GET_ASSOCIAtION_ID** command is used to get the value of the association id for the Entity.

*currentConfiguration* The **GET_CONFIGURATION** command is used to get the current Configuration of the Entity. 
 (optional) (default to null)

// Get descriptor ENTITY from Database or device
[apiInstance getDescEntityWith:deviceId
    entity:entity
              completionHandler: ^(ENTITY output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.EntityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*entityName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*groupName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*associationId* ** The **GET_ASSOCIAtION_ID** command is used to get the value of the association id for the Entity.

*currentConfiguration* The **GET_CONFIGURATION** command is used to get the current Configuration of the Entity. 

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescEntity(deviceId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescEntityExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new EntityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*entityName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*groupName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*associationId* ** The **GET_ASSOCIAtION_ID** command is used to get the value of the association id for the Entity.

*currentConfiguration* The **GET_CONFIGURATION** command is used to get the current Configuration of the Entity. 
 (optional)  (default to null)

            try {
                // Get descriptor ENTITY from Database or device
                ENTITY result = apiInstance.getDescEntity(deviceId, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityApi.getDescEntity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*entityName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*groupName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*associationId* ** The **GET_ASSOCIAtION_ID** command is used to get the value of the association id for the Entity.

*currentConfiguration* The **GET_CONFIGURATION** command is used to get the current Configuration of the Entity. 


try {
    $result = $api_instance->getDescEntity($deviceId, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntityApi->getDescEntity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*entityName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*groupName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*associationId* ** The **GET_ASSOCIAtION_ID** command is used to get the value of the association id for the Entity.

*currentConfiguration* The **GET_CONFIGURATION** command is used to get the current Configuration of the Entity. 


eval { 
    my $result = $api_instance->getDescEntity(deviceId => $deviceId, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntityApi->getDescEntity: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*entityName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*groupName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*associationId* ** The **GET_ASSOCIAtION_ID** command is used to get the value of the association id for the Entity.

*currentConfiguration* The **GET_CONFIGURATION** command is used to get the current Configuration of the Entity. 
 (optional) (default to null)

try: 
    # Get descriptor ENTITY from Database or device
    api_response = api_instance.get_desc_entity(deviceId, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityApi->getDescEntity: %s\n" % e)
extern crate EntityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let entity = ; // array[String]

    let mut context = EntityApi::Context::default();
    let result = client.getDescEntity(deviceId, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *entityName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on. *groupName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on. *associationId* ** The **GET_ASSOCIAtION_ID** command is used to get the value of the association id for the Entity. *currentConfiguration* The **GET_CONFIGURATION** command is used to get the current Configuration of the Entity.

Responses


lockDescEntity

The **LOCK** command is used to provide short-term exlusive access to the Entity to perform atomic operations. The lock times out after one minute. The lock command may be repeted by current owner of the to keep the lock alive longer, but it is expected that the lock is for short-term use only an long-term access restrictions are handle by acquiring. Most do not support sub-trees.


/v1.0/devices/{deviceId}/descriptor/entity/lock

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/lock"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityApi;

import java.io.File;
import java.util.*;

public class EntityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        EntityApi apiInstance = new EntityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        String flags = flags_example; // String | 
        
        try {
            inline_response_200_10 result = apiInstance.lockDescEntity(deviceId, flags);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityApi#lockDescEntity");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EntityApi;

public class EntityApiExample {
    public static void main(String[] args) {
        EntityApi apiInstance = new EntityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        String flags = flags_example; // String | 
        
        try {
            inline_response_200_10 result = apiInstance.lockDescEntity(deviceId, flags);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityApi#lockDescEntity");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityApi *apiInstance = [[EntityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
String *flags = flags_example; //  (default to null)

[apiInstance lockDescEntityWith:deviceId
    flags:flags
              completionHandler: ^(inline_response_200_10 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.EntityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var flags = flags_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.lockDescEntity(deviceId, flags, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class lockDescEntityExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new EntityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var flags = flags_example;  // String |  (default to null)

            try {
                inline_response_200_10 result = apiInstance.lockDescEntity(deviceId, flags);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityApi.lockDescEntity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$flags = flags_example; // String | 

try {
    $result = $api_instance->lockDescEntity($deviceId, $flags);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntityApi->lockDescEntity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $flags = flags_example; # String | 

eval { 
    my $result = $api_instance->lockDescEntity(deviceId => $deviceId, flags => $flags);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntityApi->lockDescEntity: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
flags = flags_example # String |  (default to null)

try: 
    api_response = api_instance.lock_desc_entity(deviceId, flags)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityApi->lockDescEntity: %s\n" % e)
extern crate EntityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let flags = flags_example; // String

    let mut context = EntityApi::Context::default();
    let result = client.lockDescEntity(deviceId, flags, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
Form parameters
Name Description
flags*
String
Enum: lock, unlock
Required

Responses


modifyDescEntity

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *entityName*,*GroupName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command. *associationId* The **SET_ASSOCIATION_ID** command is used to set the value of the association id for the Entity. You can delete this id with the value ff-ff-ff-ff-ff-ff-ff-ff. *currentConfiguration* The **SET_CONFIGURATION** command is used to change the current Configuration of the Entity. A Configuration can only ba charge when that charge will not have an effekt on any Active Streams. If Streams are active and changing the Configuration will impact those Streams.


/v1.0/devices/{deviceId}/descriptor/entity

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityApi;

import java.io.File;
import java.util.*;

public class EntityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        EntityApi apiInstance = new EntityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        ENTITY1 eNTITY1 = {ENTITY={entityName=DSP4YOU AVB Dongle}}; // ENTITY1 | 
        
        try {
            ENTITY result = apiInstance.modifyDescEntity(deviceId, eNTITY1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityApi#modifyDescEntity");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EntityApi;

public class EntityApiExample {
    public static void main(String[] args) {
        EntityApi apiInstance = new EntityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        ENTITY1 eNTITY1 = {ENTITY={entityName=DSP4YOU AVB Dongle}}; // ENTITY1 | 
        
        try {
            ENTITY result = apiInstance.modifyDescEntity(deviceId, eNTITY1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityApi#modifyDescEntity");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityApi *apiInstance = [[EntityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
ENTITY1 *eNTITY1 = {ENTITY={entityName=DSP4YOU AVB Dongle}}; //  (optional)

// modify Descriptor variable Values
[apiInstance modifyDescEntityWith:deviceId
    eNTITY1:eNTITY1
              completionHandler: ^(ENTITY output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.EntityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var opts = {
  'eNTITY1': {ENTITY={entityName=DSP4YOU AVB Dongle}} // {ENTITY1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyDescEntity(deviceId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyDescEntityExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new EntityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var eNTITY1 = new ENTITY1(); // ENTITY1 |  (optional) 

            try {
                // modify Descriptor variable Values
                ENTITY result = apiInstance.modifyDescEntity(deviceId, eNTITY1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityApi.modifyDescEntity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$eNTITY1 = {ENTITY={entityName=DSP4YOU AVB Dongle}}; // ENTITY1 | 

try {
    $result = $api_instance->modifyDescEntity($deviceId, $eNTITY1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntityApi->modifyDescEntity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $eNTITY1 = WWW::OPenAPIClient::Object::ENTITY1->new(); # ENTITY1 | 

eval { 
    my $result = $api_instance->modifyDescEntity(deviceId => $deviceId, eNTITY1 => $eNTITY1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntityApi->modifyDescEntity: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
eNTITY1 = {ENTITY={entityName=DSP4YOU AVB Dongle}} # ENTITY1 |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.modify_desc_entity(deviceId, eNTITY1=eNTITY1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityApi->modifyDescEntity: %s\n" % e)
extern crate EntityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let eNTITY1 = {ENTITY={entityName=DSP4YOU AVB Dongle}}; // ENTITY1

    let mut context = EntityApi::Context::default();
    let result = client.modifyDescEntity(deviceId, eNTITY1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
Body parameters
Name Description
eNTITY1

Patch variable Values

Responses


rebootDescEntity

Reboot Device from Descriptor Entity

The **REBOOT** command is used to power cycle an Entity. If the Entity has MEMORY_OBJECT descriptors with a memory_object_type of FIRMWARE_IMAGE, then the REBOOT command may be used to select a firmware image to start after the reboot. In this case, the descriptor_type field is set to MEMORY_OBJECT and the descriptor_index is set to the index of the MEMORY_OBJECT to use.


/v1.0/devices/{deviceId}/descriptor/entity/reboot

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/reboot"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityApi;

import java.io.File;
import java.util.*;

public class EntityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        EntityApi apiInstance = new EntityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Boolean boot = true; // Boolean | 
        
        try {
            inline_response_200_7 result = apiInstance.rebootDescEntity(deviceId, boot);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityApi#rebootDescEntity");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EntityApi;

public class EntityApiExample {
    public static void main(String[] args) {
        EntityApi apiInstance = new EntityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Boolean boot = true; // Boolean | 
        
        try {
            inline_response_200_7 result = apiInstance.rebootDescEntity(deviceId, boot);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityApi#rebootDescEntity");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityApi *apiInstance = [[EntityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Boolean *boot = true; //  (optional) (default to true)

// Reboot Device from Descriptor Entity
[apiInstance rebootDescEntityWith:deviceId
    boot:boot
              completionHandler: ^(inline_response_200_7 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.EntityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var opts = {
  'boot': true // {Boolean} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.rebootDescEntity(deviceId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class rebootDescEntityExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new EntityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var boot = true;  // Boolean |  (optional)  (default to true)

            try {
                // Reboot Device from Descriptor Entity
                inline_response_200_7 result = apiInstance.rebootDescEntity(deviceId, boot);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityApi.rebootDescEntity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$boot = true; // Boolean | 

try {
    $result = $api_instance->rebootDescEntity($deviceId, $boot);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntityApi->rebootDescEntity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $boot = true; # Boolean | 

eval { 
    my $result = $api_instance->rebootDescEntity(deviceId => $deviceId, boot => $boot);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntityApi->rebootDescEntity: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
boot = true # Boolean |  (optional) (default to true)

try: 
    # Reboot Device from Descriptor Entity
    api_response = api_instance.reboot_desc_entity(deviceId, boot=boot)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityApi->rebootDescEntity: %s\n" % e)
extern crate EntityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let boot = true; // Boolean

    let mut context = EntityApi::Context::default();
    let result = client.rebootDescEntity(deviceId, boot, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
Form parameters
Name Description
boot
Boolean

Responses


writeDescEntity

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityApi;

import java.io.File;
import java.util.*;

public class EntityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        EntityApi apiInstance = new EntityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            ENTITY result = apiInstance.writeDescEntity(deviceId, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityApi#writeDescEntity");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EntityApi;

public class EntityApiExample {
    public static void main(String[] args) {
        EntityApi apiInstance = new EntityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            ENTITY result = apiInstance.writeDescEntity(deviceId, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityApi#writeDescEntity");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityApi *apiInstance = [[EntityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance writeDescEntityWith:deviceId
    length:length
    data:data
              completionHandler: ^(ENTITY output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.EntityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescEntity(deviceId, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescEntityExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new EntityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                ENTITY result = apiInstance.writeDescEntity(deviceId, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityApi.writeDescEntity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescEntity($deviceId, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntityApi->writeDescEntity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescEntity(deviceId => $deviceId, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntityApi->writeDescEntity: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.write_desc_entity(deviceId, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityApi->writeDescEntity: %s\n" % e)
extern crate EntityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = EntityApi::Context::default();
    let result = client.writeDescEntity(deviceId, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


Flows

v10DevicesDeviceIdFlowsGet

Get Entity flows commands


/v1.0/devices/{deviceId}/flows

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/flows"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlowsApi;

import java.io.File;
import java.util.*;

public class FlowsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        FlowsApi apiInstance = new FlowsApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            flows result = apiInstance.v10DevicesDeviceIdFlowsGet(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowsApi#v10DevicesDeviceIdFlowsGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FlowsApi;

public class FlowsApiExample {
    public static void main(String[] args) {
        FlowsApi apiInstance = new FlowsApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            flows result = apiInstance.v10DevicesDeviceIdFlowsGet(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowsApi#v10DevicesDeviceIdFlowsGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlowsApi *apiInstance = [[FlowsApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)

// Get Entity flows commands
[apiInstance v10DevicesDeviceIdFlowsGetWith:deviceId
              completionHandler: ^(flows output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.FlowsApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdFlowsGet(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdFlowsGetExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new FlowsApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)

            try {
                // Get Entity flows commands
                flows result = apiInstance.v10DevicesDeviceIdFlowsGet(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlowsApi.v10DevicesDeviceIdFlowsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlowsApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier


try {
    $result = $api_instance->v10DevicesDeviceIdFlowsGet($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FlowsApi->v10DevicesDeviceIdFlowsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FlowsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlowsApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier


eval { 
    my $result = $api_instance->v10DevicesDeviceIdFlowsGet(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FlowsApi->v10DevicesDeviceIdFlowsGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.FlowsApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)

try: 
    # Get Entity flows commands
    api_response = api_instance.v10_devices_device_id_flows_get(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlowsApi->v10DevicesDeviceIdFlowsGet: %s\n" % e)
extern crate FlowsApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = FlowsApi::Context::default();
    let result = client.v10DevicesDeviceIdFlowsGet(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required

Responses


v10DevicesDeviceIdFlowsSingleGet

Single flow interface


/v1.0/devices/{deviceId}/flows/single

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/flows/single"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlowsApi;

import java.io.File;
import java.util.*;

public class FlowsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        FlowsApi apiInstance = new FlowsApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            single result = apiInstance.v10DevicesDeviceIdFlowsSingleGet(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowsApi#v10DevicesDeviceIdFlowsSingleGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FlowsApi;

public class FlowsApiExample {
    public static void main(String[] args) {
        FlowsApi apiInstance = new FlowsApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            single result = apiInstance.v10DevicesDeviceIdFlowsSingleGet(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowsApi#v10DevicesDeviceIdFlowsSingleGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlowsApi *apiInstance = [[FlowsApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)

// Single flow interface
[apiInstance v10DevicesDeviceIdFlowsSingleGetWith:deviceId
              completionHandler: ^(single output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.FlowsApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdFlowsSingleGet(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdFlowsSingleGetExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new FlowsApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)

            try {
                // Single flow interface
                single result = apiInstance.v10DevicesDeviceIdFlowsSingleGet(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlowsApi.v10DevicesDeviceIdFlowsSingleGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlowsApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier


try {
    $result = $api_instance->v10DevicesDeviceIdFlowsSingleGet($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FlowsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlowsApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier


eval { 
    my $result = $api_instance->v10DevicesDeviceIdFlowsSingleGet(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.FlowsApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)

try: 
    # Single flow interface
    api_response = api_instance.v10_devices_device_id_flows_single_get(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleGet: %s\n" % e)
extern crate FlowsApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = FlowsApi::Context::default();
    let result = client.v10DevicesDeviceIdFlowsSingleGet(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required

Responses


v10DevicesDeviceIdFlowsSingleReceiverGet

Get all receivers uniques


/v1.0/devices/{deviceId}/flows/single/receiver

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/flows/single/receiver"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlowsApi;

import java.io.File;
import java.util.*;

public class FlowsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        FlowsApi apiInstance = new FlowsApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            receiver result = apiInstance.v10DevicesDeviceIdFlowsSingleReceiverGet(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowsApi#v10DevicesDeviceIdFlowsSingleReceiverGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FlowsApi;

public class FlowsApiExample {
    public static void main(String[] args) {
        FlowsApi apiInstance = new FlowsApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            receiver result = apiInstance.v10DevicesDeviceIdFlowsSingleReceiverGet(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowsApi#v10DevicesDeviceIdFlowsSingleReceiverGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlowsApi *apiInstance = [[FlowsApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)

// Get all receivers uniques
[apiInstance v10DevicesDeviceIdFlowsSingleReceiverGetWith:deviceId
              completionHandler: ^(receiver output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.FlowsApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdFlowsSingleReceiverGet(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdFlowsSingleReceiverGetExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new FlowsApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)

            try {
                // Get all receivers uniques
                receiver result = apiInstance.v10DevicesDeviceIdFlowsSingleReceiverGet(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlowsApi.v10DevicesDeviceIdFlowsSingleReceiverGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlowsApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier


try {
    $result = $api_instance->v10DevicesDeviceIdFlowsSingleReceiverGet($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleReceiverGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FlowsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlowsApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier


eval { 
    my $result = $api_instance->v10DevicesDeviceIdFlowsSingleReceiverGet(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleReceiverGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.FlowsApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)

try: 
    # Get all receivers uniques
    api_response = api_instance.v10_devices_device_id_flows_single_receiver_get(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleReceiverGet: %s\n" % e)
extern crate FlowsApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = FlowsApi::Context::default();
    let result = client.v10DevicesDeviceIdFlowsSingleReceiverGet(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required

Responses


v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxGet

Get all receivers Status Pages


/v1.0/devices/{deviceId}/flows/single/receiver/{receiver_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/flows/single/receiver/{receiver_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlowsApi;

import java.io.File;
import java.util.*;

public class FlowsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        FlowsApi apiInstance = new FlowsApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer receiverIdx = 0; // Integer | Unique identfier

        
        try {
            receiverStatus result = apiInstance.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxGet(deviceId, receiverIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowsApi#v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FlowsApi;

public class FlowsApiExample {
    public static void main(String[] args) {
        FlowsApi apiInstance = new FlowsApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer receiverIdx = 0; // Integer | Unique identfier

        
        try {
            receiverStatus result = apiInstance.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxGet(deviceId, receiverIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowsApi#v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlowsApi *apiInstance = [[FlowsApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *receiverIdx = 0; // Unique identfier
 (default to null)

// Get all receivers Status Pages
[apiInstance v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxGetWith:deviceId
    receiverIdx:receiverIdx
              completionHandler: ^(receiverStatus output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.FlowsApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var receiverIdx = 0; // {Integer} Unique identfier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxGet(deviceId, receiverIdx, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxGetExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new FlowsApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var receiverIdx = 0;  // Integer | Unique identfier
 (default to null)

            try {
                // Get all receivers Status Pages
                receiverStatus result = apiInstance.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxGet(deviceId, receiverIdx);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlowsApi.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlowsApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$receiverIdx = 0; // Integer | Unique identfier


try {
    $result = $api_instance->v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxGet($deviceId, $receiverIdx);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FlowsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlowsApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $receiverIdx = 0; # Integer | Unique identfier


eval { 
    my $result = $api_instance->v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxGet(deviceId => $deviceId, receiverIdx => $receiverIdx);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.FlowsApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
receiverIdx = 0 # Integer | Unique identfier
 (default to null)

try: 
    # Get all receivers Status Pages
    api_response = api_instance.v10_devices_device_id_flows_single_receiver_receiver_idx_get(deviceId, receiverIdx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxGet: %s\n" % e)
extern crate FlowsApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let receiverIdx = 0; // Integer

    let mut context = FlowsApi::Context::default();
    let result = client.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxGet(deviceId, receiverIdx, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
receiver_idx*
Integer
Unique identfier
Required

Responses


v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxPatch

Patch connections states


/v1.0/devices/{deviceId}/flows/single/receiver/{receiver_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/flows/single/receiver/{receiver_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlowsApi;

import java.io.File;
import java.util.*;

public class FlowsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        FlowsApi apiInstance = new FlowsApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer receiverIdx = 0; // Integer | Unique identfier

        String flowState = flowState_example; // String | 
        String talkerEntityId = talkerEntityId_example; // String | 
        Integer talkerUniqueId = 56; // Integer | 
        
        try {
            receiverStatus result = apiInstance.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxPatch(deviceId, receiverIdx, flowState, talkerEntityId, talkerUniqueId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowsApi#v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxPatch");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FlowsApi;

public class FlowsApiExample {
    public static void main(String[] args) {
        FlowsApi apiInstance = new FlowsApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer receiverIdx = 0; // Integer | Unique identfier

        String flowState = flowState_example; // String | 
        String talkerEntityId = talkerEntityId_example; // String | 
        Integer talkerUniqueId = 56; // Integer | 
        
        try {
            receiverStatus result = apiInstance.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxPatch(deviceId, receiverIdx, flowState, talkerEntityId, talkerUniqueId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowsApi#v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxPatch");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlowsApi *apiInstance = [[FlowsApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *receiverIdx = 0; // Unique identfier
 (default to null)
String *flowState = flowState_example; //  (default to Disconnected)
String *talkerEntityId = talkerEntityId_example; //  (optional) (default to null)
Integer *talkerUniqueId = 56; //  (optional) (default to null)

// Patch connections states
[apiInstance v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxPatchWith:deviceId
    receiverIdx:receiverIdx
    flowState:flowState
    talkerEntityId:talkerEntityId
    talkerUniqueId:talkerUniqueId
              completionHandler: ^(receiverStatus output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.FlowsApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var receiverIdx = 0; // {Integer} Unique identfier

var flowState = flowState_example; // {String} 
var opts = {
  'talkerEntityId': talkerEntityId_example, // {String} 
  'talkerUniqueId': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxPatch(deviceId, receiverIdx, flowState, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxPatchExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new FlowsApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var receiverIdx = 0;  // Integer | Unique identfier
 (default to null)
            var flowState = flowState_example;  // String |  (default to Disconnected)
            var talkerEntityId = talkerEntityId_example;  // String |  (optional)  (default to null)
            var talkerUniqueId = 56;  // Integer |  (optional)  (default to null)

            try {
                // Patch connections states
                receiverStatus result = apiInstance.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxPatch(deviceId, receiverIdx, flowState, talkerEntityId, talkerUniqueId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlowsApi.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlowsApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$receiverIdx = 0; // Integer | Unique identfier

$flowState = flowState_example; // String | 
$talkerEntityId = talkerEntityId_example; // String | 
$talkerUniqueId = 56; // Integer | 

try {
    $result = $api_instance->v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxPatch($deviceId, $receiverIdx, $flowState, $talkerEntityId, $talkerUniqueId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FlowsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlowsApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $receiverIdx = 0; # Integer | Unique identfier

my $flowState = flowState_example; # String | 
my $talkerEntityId = talkerEntityId_example; # String | 
my $talkerUniqueId = 56; # Integer | 

eval { 
    my $result = $api_instance->v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxPatch(deviceId => $deviceId, receiverIdx => $receiverIdx, flowState => $flowState, talkerEntityId => $talkerEntityId, talkerUniqueId => $talkerUniqueId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxPatch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.FlowsApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
receiverIdx = 0 # Integer | Unique identfier
 (default to null)
flowState = flowState_example # String |  (default to Disconnected)
talkerEntityId = talkerEntityId_example # String |  (optional) (default to null)
talkerUniqueId = 56 # Integer |  (optional) (default to null)

try: 
    # Patch connections states
    api_response = api_instance.v10_devices_device_id_flows_single_receiver_receiver_idx_patch(deviceId, receiverIdx, flowState, talkerEntityId=talkerEntityId, talkerUniqueId=talkerUniqueId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxPatch: %s\n" % e)
extern crate FlowsApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let receiverIdx = 0; // Integer
    let flowState = flowState_example; // String
    let talkerEntityId = talkerEntityId_example; // String
    let talkerUniqueId = 56; // Integer

    let mut context = FlowsApi::Context::default();
    let result = client.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxPatch(deviceId, receiverIdx, flowState, talkerEntityId, talkerUniqueId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
receiver_idx*
Integer
Unique identfier
Required
Form parameters
Name Description
flowState*
String
Enum: Disconnected, Connected
Required
talkerEntityId
String
talkerUniqueId
Integer

Responses


v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderGet

Get all connectable Senders


/v1.0/devices/{deviceId}/flows/single/receiver/{receiver_idx}/sender

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/flows/single/receiver/{receiver_idx}/sender"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlowsApi;

import java.io.File;
import java.util.*;

public class FlowsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        FlowsApi apiInstance = new FlowsApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer receiverIdx = 0; // Integer | Unique identfier

        
        try {
            senderConnectable result = apiInstance.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderGet(deviceId, receiverIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowsApi#v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FlowsApi;

public class FlowsApiExample {
    public static void main(String[] args) {
        FlowsApi apiInstance = new FlowsApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer receiverIdx = 0; // Integer | Unique identfier

        
        try {
            senderConnectable result = apiInstance.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderGet(deviceId, receiverIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowsApi#v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlowsApi *apiInstance = [[FlowsApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *receiverIdx = 0; // Unique identfier
 (default to null)

// Get all  connectable Senders
[apiInstance v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderGetWith:deviceId
    receiverIdx:receiverIdx
              completionHandler: ^(senderConnectable output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.FlowsApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var receiverIdx = 0; // {Integer} Unique identfier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderGet(deviceId, receiverIdx, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderGetExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new FlowsApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var receiverIdx = 0;  // Integer | Unique identfier
 (default to null)

            try {
                // Get all  connectable Senders
                senderConnectable result = apiInstance.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderGet(deviceId, receiverIdx);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlowsApi.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlowsApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$receiverIdx = 0; // Integer | Unique identfier


try {
    $result = $api_instance->v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderGet($deviceId, $receiverIdx);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FlowsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlowsApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $receiverIdx = 0; # Integer | Unique identfier


eval { 
    my $result = $api_instance->v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderGet(deviceId => $deviceId, receiverIdx => $receiverIdx);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.FlowsApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
receiverIdx = 0 # Integer | Unique identfier
 (default to null)

try: 
    # Get all  connectable Senders
    api_response = api_instance.v10_devices_device_id_flows_single_receiver_receiver_idx_sender_get(deviceId, receiverIdx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderGet: %s\n" % e)
extern crate FlowsApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let receiverIdx = 0; // Integer

    let mut context = FlowsApi::Context::default();
    let result = client.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderGet(deviceId, receiverIdx, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
receiver_idx*
Integer
Unique identfier
Required

Responses


v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdGet

Get connectable Ports from Sender


/v1.0/devices/{deviceId}/flows/single/receiver/{receiver_idx}/sender/{sender_id}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/flows/single/receiver/{receiver_idx}/sender/{sender_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlowsApi;

import java.io.File;
import java.util.*;

public class FlowsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        FlowsApi apiInstance = new FlowsApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer receiverIdx = 0; // Integer | Unique identfier

        String senderId = 00-50-c2-ff-fe-d4-33-2b; // String | Unique or Port identfier
        
        try {
            senderConnectablePort result = apiInstance.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdGet(deviceId, receiverIdx, senderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowsApi#v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FlowsApi;

public class FlowsApiExample {
    public static void main(String[] args) {
        FlowsApi apiInstance = new FlowsApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer receiverIdx = 0; // Integer | Unique identfier

        String senderId = 00-50-c2-ff-fe-d4-33-2b; // String | Unique or Port identfier
        
        try {
            senderConnectablePort result = apiInstance.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdGet(deviceId, receiverIdx, senderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowsApi#v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlowsApi *apiInstance = [[FlowsApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *receiverIdx = 0; // Unique identfier
 (default to null)
String *senderId = 00-50-c2-ff-fe-d4-33-2b; // Unique or Port identfier (default to null)

// Get connectable Ports from Sender
[apiInstance v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdGetWith:deviceId
    receiverIdx:receiverIdx
    senderId:senderId
              completionHandler: ^(senderConnectablePort output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.FlowsApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var receiverIdx = 0; // {Integer} Unique identfier

var senderId = 00-50-c2-ff-fe-d4-33-2b; // {String} Unique or Port identfier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdGet(deviceId, receiverIdx, senderId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdGetExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new FlowsApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var receiverIdx = 0;  // Integer | Unique identfier
 (default to null)
            var senderId = 00-50-c2-ff-fe-d4-33-2b;  // String | Unique or Port identfier (default to null)

            try {
                // Get connectable Ports from Sender
                senderConnectablePort result = apiInstance.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdGet(deviceId, receiverIdx, senderId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlowsApi.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlowsApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$receiverIdx = 0; // Integer | Unique identfier

$senderId = 00-50-c2-ff-fe-d4-33-2b; // String | Unique or Port identfier

try {
    $result = $api_instance->v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdGet($deviceId, $receiverIdx, $senderId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FlowsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlowsApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $receiverIdx = 0; # Integer | Unique identfier

my $senderId = 00-50-c2-ff-fe-d4-33-2b; # String | Unique or Port identfier

eval { 
    my $result = $api_instance->v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdGet(deviceId => $deviceId, receiverIdx => $receiverIdx, senderId => $senderId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.FlowsApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
receiverIdx = 0 # Integer | Unique identfier
 (default to null)
senderId = 00-50-c2-ff-fe-d4-33-2b # String | Unique or Port identfier (default to null)

try: 
    # Get connectable Ports from Sender
    api_response = api_instance.v10_devices_device_id_flows_single_receiver_receiver_idx_sender_sender_id_get(deviceId, receiverIdx, senderId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdGet: %s\n" % e)
extern crate FlowsApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let receiverIdx = 0; // Integer
    let senderId = 00-50-c2-ff-fe-d4-33-2b; // String

    let mut context = FlowsApi::Context::default();
    let result = client.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdGet(deviceId, receiverIdx, senderId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
receiver_idx*
Integer
Unique identfier
Required
sender_id*
String
Unique or Port identfier
Required

Responses


v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdSenderIdxGet

Get Connections Status Pages


/v1.0/devices/{deviceId}/flows/single/receiver/{receiver_idx}/sender/{sender_id}/{sender_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/flows/single/receiver/{receiver_idx}/sender/{sender_id}/{sender_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlowsApi;

import java.io.File;
import java.util.*;

public class FlowsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        FlowsApi apiInstance = new FlowsApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer receiverIdx = 0; // Integer | Unique identfier

        String senderId = 00-50-c2-ff-fe-d4-33-2b; // String | Unique or Port identfier
        Integer senderIdx = 0; // Integer | Sender unique identfier

        
        try {
            connectionStatus result = apiInstance.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdSenderIdxGet(deviceId, receiverIdx, senderId, senderIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowsApi#v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdSenderIdxGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FlowsApi;

public class FlowsApiExample {
    public static void main(String[] args) {
        FlowsApi apiInstance = new FlowsApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer receiverIdx = 0; // Integer | Unique identfier

        String senderId = 00-50-c2-ff-fe-d4-33-2b; // String | Unique or Port identfier
        Integer senderIdx = 0; // Integer | Sender unique identfier

        
        try {
            connectionStatus result = apiInstance.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdSenderIdxGet(deviceId, receiverIdx, senderId, senderIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowsApi#v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdSenderIdxGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlowsApi *apiInstance = [[FlowsApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *receiverIdx = 0; // Unique identfier
 (default to null)
String *senderId = 00-50-c2-ff-fe-d4-33-2b; // Unique or Port identfier (default to null)
Integer *senderIdx = 0; // Sender unique identfier
 (default to null)

// Get Connections Status Pages
[apiInstance v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdSenderIdxGetWith:deviceId
    receiverIdx:receiverIdx
    senderId:senderId
    senderIdx:senderIdx
              completionHandler: ^(connectionStatus output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.FlowsApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var receiverIdx = 0; // {Integer} Unique identfier

var senderId = 00-50-c2-ff-fe-d4-33-2b; // {String} Unique or Port identfier
var senderIdx = 0; // {Integer} Sender unique identfier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdSenderIdxGet(deviceId, receiverIdx, senderId, senderIdx, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdSenderIdxGetExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new FlowsApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var receiverIdx = 0;  // Integer | Unique identfier
 (default to null)
            var senderId = 00-50-c2-ff-fe-d4-33-2b;  // String | Unique or Port identfier (default to null)
            var senderIdx = 0;  // Integer | Sender unique identfier
 (default to null)

            try {
                // Get Connections Status Pages
                connectionStatus result = apiInstance.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdSenderIdxGet(deviceId, receiverIdx, senderId, senderIdx);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlowsApi.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdSenderIdxGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlowsApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$receiverIdx = 0; // Integer | Unique identfier

$senderId = 00-50-c2-ff-fe-d4-33-2b; // String | Unique or Port identfier
$senderIdx = 0; // Integer | Sender unique identfier


try {
    $result = $api_instance->v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdSenderIdxGet($deviceId, $receiverIdx, $senderId, $senderIdx);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdSenderIdxGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FlowsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlowsApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $receiverIdx = 0; # Integer | Unique identfier

my $senderId = 00-50-c2-ff-fe-d4-33-2b; # String | Unique or Port identfier
my $senderIdx = 0; # Integer | Sender unique identfier


eval { 
    my $result = $api_instance->v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdSenderIdxGet(deviceId => $deviceId, receiverIdx => $receiverIdx, senderId => $senderId, senderIdx => $senderIdx);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdSenderIdxGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.FlowsApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
receiverIdx = 0 # Integer | Unique identfier
 (default to null)
senderId = 00-50-c2-ff-fe-d4-33-2b # String | Unique or Port identfier (default to null)
senderIdx = 0 # Integer | Sender unique identfier
 (default to null)

try: 
    # Get Connections Status Pages
    api_response = api_instance.v10_devices_device_id_flows_single_receiver_receiver_idx_sender_sender_id_sender_idx_get(deviceId, receiverIdx, senderId, senderIdx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdSenderIdxGet: %s\n" % e)
extern crate FlowsApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let receiverIdx = 0; // Integer
    let senderId = 00-50-c2-ff-fe-d4-33-2b; // String
    let senderIdx = 0; // Integer

    let mut context = FlowsApi::Context::default();
    let result = client.v10DevicesDeviceIdFlowsSingleReceiverReceiverIdxSenderSenderIdSenderIdxGet(deviceId, receiverIdx, senderId, senderIdx, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
receiver_idx*
Integer
Unique identfier
Required
sender_id*
String
Unique or Port identfier
Required
sender_idx*
Integer
Sender unique identfier
Required

Responses


v10DevicesDeviceIdFlowsSingleSenderGet

Get all receivers uniques


/v1.0/devices/{deviceId}/flows/single/sender

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/flows/single/sender"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlowsApi;

import java.io.File;
import java.util.*;

public class FlowsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        FlowsApi apiInstance = new FlowsApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            sender result = apiInstance.v10DevicesDeviceIdFlowsSingleSenderGet(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowsApi#v10DevicesDeviceIdFlowsSingleSenderGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FlowsApi;

public class FlowsApiExample {
    public static void main(String[] args) {
        FlowsApi apiInstance = new FlowsApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            sender result = apiInstance.v10DevicesDeviceIdFlowsSingleSenderGet(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowsApi#v10DevicesDeviceIdFlowsSingleSenderGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlowsApi *apiInstance = [[FlowsApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)

// Get all receivers uniques
[apiInstance v10DevicesDeviceIdFlowsSingleSenderGetWith:deviceId
              completionHandler: ^(sender output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.FlowsApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdFlowsSingleSenderGet(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdFlowsSingleSenderGetExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new FlowsApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)

            try {
                // Get all receivers uniques
                sender result = apiInstance.v10DevicesDeviceIdFlowsSingleSenderGet(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlowsApi.v10DevicesDeviceIdFlowsSingleSenderGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlowsApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier


try {
    $result = $api_instance->v10DevicesDeviceIdFlowsSingleSenderGet($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleSenderGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FlowsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlowsApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier


eval { 
    my $result = $api_instance->v10DevicesDeviceIdFlowsSingleSenderGet(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleSenderGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.FlowsApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)

try: 
    # Get all receivers uniques
    api_response = api_instance.v10_devices_device_id_flows_single_sender_get(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleSenderGet: %s\n" % e)
extern crate FlowsApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = FlowsApi::Context::default();
    let result = client.v10DevicesDeviceIdFlowsSingleSenderGet(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required

Responses


v10DevicesDeviceIdFlowsSingleSenderSenderIdxGet

Get all sender Status Pages


/v1.0/devices/{deviceId}/flows/single/sender/{sender_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/flows/single/sender/{sender_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlowsApi;

import java.io.File;
import java.util.*;

public class FlowsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        FlowsApi apiInstance = new FlowsApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer senderIdx = 0; // Integer | Unique identfier

        
        try {
            senderStatus result = apiInstance.v10DevicesDeviceIdFlowsSingleSenderSenderIdxGet(deviceId, senderIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowsApi#v10DevicesDeviceIdFlowsSingleSenderSenderIdxGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FlowsApi;

public class FlowsApiExample {
    public static void main(String[] args) {
        FlowsApi apiInstance = new FlowsApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer senderIdx = 0; // Integer | Unique identfier

        
        try {
            senderStatus result = apiInstance.v10DevicesDeviceIdFlowsSingleSenderSenderIdxGet(deviceId, senderIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowsApi#v10DevicesDeviceIdFlowsSingleSenderSenderIdxGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlowsApi *apiInstance = [[FlowsApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *senderIdx = 0; // Unique identfier
 (default to null)

// Get all sender Status Pages
[apiInstance v10DevicesDeviceIdFlowsSingleSenderSenderIdxGetWith:deviceId
    senderIdx:senderIdx
              completionHandler: ^(senderStatus output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.FlowsApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var senderIdx = 0; // {Integer} Unique identfier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v10DevicesDeviceIdFlowsSingleSenderSenderIdxGet(deviceId, senderIdx, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class v10DevicesDeviceIdFlowsSingleSenderSenderIdxGetExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new FlowsApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var senderIdx = 0;  // Integer | Unique identfier
 (default to null)

            try {
                // Get all sender Status Pages
                senderStatus result = apiInstance.v10DevicesDeviceIdFlowsSingleSenderSenderIdxGet(deviceId, senderIdx);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlowsApi.v10DevicesDeviceIdFlowsSingleSenderSenderIdxGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlowsApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$senderIdx = 0; // Integer | Unique identfier


try {
    $result = $api_instance->v10DevicesDeviceIdFlowsSingleSenderSenderIdxGet($deviceId, $senderIdx);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleSenderSenderIdxGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FlowsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlowsApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $senderIdx = 0; # Integer | Unique identfier


eval { 
    my $result = $api_instance->v10DevicesDeviceIdFlowsSingleSenderSenderIdxGet(deviceId => $deviceId, senderIdx => $senderIdx);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleSenderSenderIdxGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.FlowsApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
senderIdx = 0 # Integer | Unique identfier
 (default to null)

try: 
    # Get all sender Status Pages
    api_response = api_instance.v10_devices_device_id_flows_single_sender_sender_idx_get(deviceId, senderIdx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlowsApi->v10DevicesDeviceIdFlowsSingleSenderSenderIdxGet: %s\n" % e)
extern crate FlowsApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let senderIdx = 0; // Integer

    let mut context = FlowsApi::Context::default();
    let result = client.v10DevicesDeviceIdFlowsSingleSenderSenderIdxGet(deviceId, senderIdx, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
sender_idx*
Integer
Unique identfier
Required

Responses


JackInput

getDescJackInput

Get jackInput Descriptor


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/jackInput/{jack_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/jackInput/{jack_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JackInputApi;

import java.io.File;
import java.util.*;

public class JackInputApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        JackInputApi apiInstance = new JackInputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer jackIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            JACK_INPUT result = apiInstance.getDescJackInput(deviceId, cfgIdx, jackIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JackInputApi#getDescJackInput");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JackInputApi;

public class JackInputApiExample {
    public static void main(String[] args) {
        JackInputApi apiInstance = new JackInputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer jackIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            JACK_INPUT result = apiInstance.getDescJackInput(deviceId, cfgIdx, jackIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JackInputApi#getDescJackInput");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JackInputApi *apiInstance = [[JackInputApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *jackIdx = 0; // Valid top level descriptor index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

// Get jackInput Descriptor
[apiInstance getDescJackInputWith:deviceId
    cfgIdx:cfgIdx
    jackIdx:jackIdx
    entity:entity
              completionHandler: ^(JACK_INPUT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.JackInputApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var jackIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescJackInput(deviceId, cfgIdx, jackIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescJackInputExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new JackInputApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var jackIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional)  (default to null)

            try {
                // Get jackInput Descriptor
                JACK_INPUT result = apiInstance.getDescJackInput(deviceId, cfgIdx, jackIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JackInputApi.getDescJackInput: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JackInputApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$jackIdx = 0; // Integer | Valid top level descriptor index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


try {
    $result = $api_instance->getDescJackInput($deviceId, $cfgIdx, $jackIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JackInputApi->getDescJackInput: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JackInputApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JackInputApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $jackIdx = 0; # Integer | Valid top level descriptor index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


eval { 
    my $result = $api_instance->getDescJackInput(deviceId => $deviceId, cfgIdx => $cfgIdx, jackIdx => $jackIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JackInputApi->getDescJackInput: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JackInputApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
jackIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

try: 
    # Get jackInput Descriptor
    api_response = api_instance.get_desc_jack_input(deviceId, cfgIdx, jackIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JackInputApi->getDescJackInput: %s\n" % e)
extern crate JackInputApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let jackIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = JackInputApi::Context::default();
    let result = client.getDescJackInput(deviceId, cfgIdx, jackIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
jack_idx*
Integer
Valid top level descriptor index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

Responses


modifyDescJackInput

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/jackInput/{jack_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/jackInput/{jack_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JackInputApi;

import java.io.File;
import java.util.*;

public class JackInputApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        JackInputApi apiInstance = new JackInputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer jackIdx = 0; // Integer | Valid top level descriptor index

        JACKINPUT1 jACKINPUT1 = {JACK_INPUT={objectName=Player A}}; // JACKINPUT1 | 
        
        try {
            JACK_INPUT result = apiInstance.modifyDescJackInput(deviceId, cfgIdx, jackIdx, jACKINPUT1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JackInputApi#modifyDescJackInput");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JackInputApi;

public class JackInputApiExample {
    public static void main(String[] args) {
        JackInputApi apiInstance = new JackInputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer jackIdx = 0; // Integer | Valid top level descriptor index

        JACKINPUT1 jACKINPUT1 = {JACK_INPUT={objectName=Player A}}; // JACKINPUT1 | 
        
        try {
            JACK_INPUT result = apiInstance.modifyDescJackInput(deviceId, cfgIdx, jackIdx, jACKINPUT1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JackInputApi#modifyDescJackInput");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JackInputApi *apiInstance = [[JackInputApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *jackIdx = 0; // Valid top level descriptor index
 (default to null)
JACKINPUT1 *jACKINPUT1 = {JACK_INPUT={objectName=Player A}}; //  (optional)

// modify Descriptor variable Values
[apiInstance modifyDescJackInputWith:deviceId
    cfgIdx:cfgIdx
    jackIdx:jackIdx
    jACKINPUT1:jACKINPUT1
              completionHandler: ^(JACK_INPUT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.JackInputApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var jackIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'jACKINPUT1': {JACK_INPUT={objectName=Player A}} // {JACKINPUT1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyDescJackInput(deviceId, cfgIdx, jackIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyDescJackInputExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new JackInputApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var jackIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var jACKINPUT1 = new JACKINPUT1(); // JACKINPUT1 |  (optional) 

            try {
                // modify Descriptor variable Values
                JACK_INPUT result = apiInstance.modifyDescJackInput(deviceId, cfgIdx, jackIdx, jACKINPUT1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JackInputApi.modifyDescJackInput: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JackInputApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$jackIdx = 0; // Integer | Valid top level descriptor index

$jACKINPUT1 = {JACK_INPUT={objectName=Player A}}; // JACKINPUT1 | 

try {
    $result = $api_instance->modifyDescJackInput($deviceId, $cfgIdx, $jackIdx, $jACKINPUT1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JackInputApi->modifyDescJackInput: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JackInputApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JackInputApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $jackIdx = 0; # Integer | Valid top level descriptor index

my $jACKINPUT1 = WWW::OPenAPIClient::Object::JACKINPUT1->new(); # JACKINPUT1 | 

eval { 
    my $result = $api_instance->modifyDescJackInput(deviceId => $deviceId, cfgIdx => $cfgIdx, jackIdx => $jackIdx, jACKINPUT1 => $jACKINPUT1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JackInputApi->modifyDescJackInput: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JackInputApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
jackIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
jACKINPUT1 = {JACK_INPUT={objectName=Player A}} # JACKINPUT1 |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.modify_desc_jack_input(deviceId, cfgIdx, jackIdx, jACKINPUT1=jACKINPUT1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JackInputApi->modifyDescJackInput: %s\n" % e)
extern crate JackInputApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let jackIdx = 0; // Integer
    let jACKINPUT1 = {JACK_INPUT={objectName=Player A}}; // JACKINPUT1

    let mut context = JackInputApi::Context::default();
    let result = client.modifyDescJackInput(deviceId, cfgIdx, jackIdx, jACKINPUT1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
jack_idx*
Integer
Valid top level descriptor index
Required
Body parameters
Name Description
jACKINPUT1

Set Object Name

Responses


writeDescJackInput

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/jackInput/{jack_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/jackInput/{jack_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JackInputApi;

import java.io.File;
import java.util.*;

public class JackInputApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        JackInputApi apiInstance = new JackInputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer jackIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            JACK_INPUT result = apiInstance.writeDescJackInput(deviceId, cfgIdx, jackIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JackInputApi#writeDescJackInput");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JackInputApi;

public class JackInputApiExample {
    public static void main(String[] args) {
        JackInputApi apiInstance = new JackInputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer jackIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            JACK_INPUT result = apiInstance.writeDescJackInput(deviceId, cfgIdx, jackIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JackInputApi#writeDescJackInput");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JackInputApi *apiInstance = [[JackInputApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *jackIdx = 0; // Valid top level descriptor index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance writeDescJackInputWith:deviceId
    cfgIdx:cfgIdx
    jackIdx:jackIdx
    length:length
    data:data
              completionHandler: ^(JACK_INPUT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.JackInputApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var jackIdx = 0; // {Integer} Valid top level descriptor index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescJackInput(deviceId, cfgIdx, jackIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescJackInputExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new JackInputApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var jackIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                JACK_INPUT result = apiInstance.writeDescJackInput(deviceId, cfgIdx, jackIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JackInputApi.writeDescJackInput: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JackInputApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$jackIdx = 0; // Integer | Valid top level descriptor index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescJackInput($deviceId, $cfgIdx, $jackIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JackInputApi->writeDescJackInput: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JackInputApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JackInputApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $jackIdx = 0; # Integer | Valid top level descriptor index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescJackInput(deviceId => $deviceId, cfgIdx => $cfgIdx, jackIdx => $jackIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JackInputApi->writeDescJackInput: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JackInputApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
jackIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.write_desc_jack_input(deviceId, cfgIdx, jackIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JackInputApi->writeDescJackInput: %s\n" % e)
extern crate JackInputApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let jackIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = JackInputApi::Context::default();
    let result = client.writeDescJackInput(deviceId, cfgIdx, jackIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
jack_idx*
Integer
Valid top level descriptor index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


JackOutput

getDescJackOutput

Get jackOutput Descriptor


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/jackOutput/{jack_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/jackOutput/{jack_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JackOutputApi;

import java.io.File;
import java.util.*;

public class JackOutputApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        JackOutputApi apiInstance = new JackOutputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer jackIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            JACK_OUTPUT result = apiInstance.getDescJackOutput(deviceId, cfgIdx, jackIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JackOutputApi#getDescJackOutput");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JackOutputApi;

public class JackOutputApiExample {
    public static void main(String[] args) {
        JackOutputApi apiInstance = new JackOutputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer jackIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            JACK_OUTPUT result = apiInstance.getDescJackOutput(deviceId, cfgIdx, jackIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JackOutputApi#getDescJackOutput");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JackOutputApi *apiInstance = [[JackOutputApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *jackIdx = 0; // Valid top level descriptor index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

// Get jackOutput Descriptor
[apiInstance getDescJackOutputWith:deviceId
    cfgIdx:cfgIdx
    jackIdx:jackIdx
    entity:entity
              completionHandler: ^(JACK_OUTPUT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.JackOutputApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var jackIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescJackOutput(deviceId, cfgIdx, jackIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescJackOutputExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new JackOutputApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var jackIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional)  (default to null)

            try {
                // Get jackOutput Descriptor
                JACK_OUTPUT result = apiInstance.getDescJackOutput(deviceId, cfgIdx, jackIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JackOutputApi.getDescJackOutput: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JackOutputApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$jackIdx = 0; // Integer | Valid top level descriptor index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


try {
    $result = $api_instance->getDescJackOutput($deviceId, $cfgIdx, $jackIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JackOutputApi->getDescJackOutput: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JackOutputApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JackOutputApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $jackIdx = 0; # Integer | Valid top level descriptor index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


eval { 
    my $result = $api_instance->getDescJackOutput(deviceId => $deviceId, cfgIdx => $cfgIdx, jackIdx => $jackIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JackOutputApi->getDescJackOutput: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JackOutputApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
jackIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

try: 
    # Get jackOutput Descriptor
    api_response = api_instance.get_desc_jack_output(deviceId, cfgIdx, jackIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JackOutputApi->getDescJackOutput: %s\n" % e)
extern crate JackOutputApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let jackIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = JackOutputApi::Context::default();
    let result = client.getDescJackOutput(deviceId, cfgIdx, jackIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
jack_idx*
Integer
Valid top level descriptor index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

Responses


modifyDescJackOutput

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/jackOutput/{jack_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/jackOutput/{jack_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JackOutputApi;

import java.io.File;
import java.util.*;

public class JackOutputApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        JackOutputApi apiInstance = new JackOutputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer jackIdx = 0; // Integer | Valid top level descriptor index

        JACKOUTPUT1 jACKOUTPUT1 = {JACK_OUTPUT={objectName=Player A}}; // JACKOUTPUT1 | 
        
        try {
            JACK_OUTPUT result = apiInstance.modifyDescJackOutput(deviceId, cfgIdx, jackIdx, jACKOUTPUT1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JackOutputApi#modifyDescJackOutput");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JackOutputApi;

public class JackOutputApiExample {
    public static void main(String[] args) {
        JackOutputApi apiInstance = new JackOutputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer jackIdx = 0; // Integer | Valid top level descriptor index

        JACKOUTPUT1 jACKOUTPUT1 = {JACK_OUTPUT={objectName=Player A}}; // JACKOUTPUT1 | 
        
        try {
            JACK_OUTPUT result = apiInstance.modifyDescJackOutput(deviceId, cfgIdx, jackIdx, jACKOUTPUT1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JackOutputApi#modifyDescJackOutput");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JackOutputApi *apiInstance = [[JackOutputApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *jackIdx = 0; // Valid top level descriptor index
 (default to null)
JACKOUTPUT1 *jACKOUTPUT1 = {JACK_OUTPUT={objectName=Player A}}; //  (optional)

// modify Descriptor variable Values
[apiInstance modifyDescJackOutputWith:deviceId
    cfgIdx:cfgIdx
    jackIdx:jackIdx
    jACKOUTPUT1:jACKOUTPUT1
              completionHandler: ^(JACK_OUTPUT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.JackOutputApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var jackIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'jACKOUTPUT1': {JACK_OUTPUT={objectName=Player A}} // {JACKOUTPUT1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyDescJackOutput(deviceId, cfgIdx, jackIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyDescJackOutputExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new JackOutputApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var jackIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var jACKOUTPUT1 = new JACKOUTPUT1(); // JACKOUTPUT1 |  (optional) 

            try {
                // modify Descriptor variable Values
                JACK_OUTPUT result = apiInstance.modifyDescJackOutput(deviceId, cfgIdx, jackIdx, jACKOUTPUT1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JackOutputApi.modifyDescJackOutput: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JackOutputApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$jackIdx = 0; // Integer | Valid top level descriptor index

$jACKOUTPUT1 = {JACK_OUTPUT={objectName=Player A}}; // JACKOUTPUT1 | 

try {
    $result = $api_instance->modifyDescJackOutput($deviceId, $cfgIdx, $jackIdx, $jACKOUTPUT1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JackOutputApi->modifyDescJackOutput: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JackOutputApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JackOutputApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $jackIdx = 0; # Integer | Valid top level descriptor index

my $jACKOUTPUT1 = WWW::OPenAPIClient::Object::JACKOUTPUT1->new(); # JACKOUTPUT1 | 

eval { 
    my $result = $api_instance->modifyDescJackOutput(deviceId => $deviceId, cfgIdx => $cfgIdx, jackIdx => $jackIdx, jACKOUTPUT1 => $jACKOUTPUT1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JackOutputApi->modifyDescJackOutput: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JackOutputApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
jackIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
jACKOUTPUT1 = {JACK_OUTPUT={objectName=Player A}} # JACKOUTPUT1 |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.modify_desc_jack_output(deviceId, cfgIdx, jackIdx, jACKOUTPUT1=jACKOUTPUT1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JackOutputApi->modifyDescJackOutput: %s\n" % e)
extern crate JackOutputApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let jackIdx = 0; // Integer
    let jACKOUTPUT1 = {JACK_OUTPUT={objectName=Player A}}; // JACKOUTPUT1

    let mut context = JackOutputApi::Context::default();
    let result = client.modifyDescJackOutput(deviceId, cfgIdx, jackIdx, jACKOUTPUT1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
jack_idx*
Integer
Valid top level descriptor index
Required
Body parameters
Name Description
jACKOUTPUT1

Set Object Name

Responses


writeDescJackOutput

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/jackOutput/{jack_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/jackOutput/{jack_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JackOutputApi;

import java.io.File;
import java.util.*;

public class JackOutputApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        JackOutputApi apiInstance = new JackOutputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer jackIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            JACK_OUTPUT result = apiInstance.writeDescJackOutput(deviceId, cfgIdx, jackIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JackOutputApi#writeDescJackOutput");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JackOutputApi;

public class JackOutputApiExample {
    public static void main(String[] args) {
        JackOutputApi apiInstance = new JackOutputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer jackIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            JACK_OUTPUT result = apiInstance.writeDescJackOutput(deviceId, cfgIdx, jackIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JackOutputApi#writeDescJackOutput");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JackOutputApi *apiInstance = [[JackOutputApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *jackIdx = 0; // Valid top level descriptor index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance writeDescJackOutputWith:deviceId
    cfgIdx:cfgIdx
    jackIdx:jackIdx
    length:length
    data:data
              completionHandler: ^(JACK_OUTPUT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.JackOutputApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var jackIdx = 0; // {Integer} Valid top level descriptor index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescJackOutput(deviceId, cfgIdx, jackIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescJackOutputExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new JackOutputApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var jackIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                JACK_OUTPUT result = apiInstance.writeDescJackOutput(deviceId, cfgIdx, jackIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JackOutputApi.writeDescJackOutput: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JackOutputApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$jackIdx = 0; // Integer | Valid top level descriptor index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescJackOutput($deviceId, $cfgIdx, $jackIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JackOutputApi->writeDescJackOutput: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JackOutputApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JackOutputApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $jackIdx = 0; # Integer | Valid top level descriptor index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescJackOutput(deviceId => $deviceId, cfgIdx => $cfgIdx, jackIdx => $jackIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JackOutputApi->writeDescJackOutput: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JackOutputApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
jackIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.write_desc_jack_output(deviceId, cfgIdx, jackIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JackOutputApi->writeDescJackOutput: %s\n" % e)
extern crate JackOutputApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let jackIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = JackOutputApi::Context::default();
    let result = client.writeDescJackOutput(deviceId, cfgIdx, jackIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
jack_idx*
Integer
Valid top level descriptor index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


Locale

getDescLocale

Get locale Descriptor


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/locale/{locale_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/locale/{locale_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LocaleApi;

import java.io.File;
import java.util.*;

public class LocaleApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        LocaleApi apiInstance = new LocaleApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer localeIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            LOCALE result = apiInstance.getDescLocale(deviceId, cfgIdx, localeIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocaleApi#getDescLocale");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LocaleApi;

public class LocaleApiExample {
    public static void main(String[] args) {
        LocaleApi apiInstance = new LocaleApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer localeIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            LOCALE result = apiInstance.getDescLocale(deviceId, cfgIdx, localeIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocaleApi#getDescLocale");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
LocaleApi *apiInstance = [[LocaleApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *localeIdx = 0; // Valid top level descriptor index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

// Get locale Descriptor
[apiInstance getDescLocaleWith:deviceId
    cfgIdx:cfgIdx
    localeIdx:localeIdx
    entity:entity
              completionHandler: ^(LOCALE output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.LocaleApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var localeIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescLocale(deviceId, cfgIdx, localeIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescLocaleExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new LocaleApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var localeIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional)  (default to null)

            try {
                // Get locale Descriptor
                LOCALE result = apiInstance.getDescLocale(deviceId, cfgIdx, localeIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LocaleApi.getDescLocale: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LocaleApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$localeIdx = 0; // Integer | Valid top level descriptor index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


try {
    $result = $api_instance->getDescLocale($deviceId, $cfgIdx, $localeIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LocaleApi->getDescLocale: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LocaleApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LocaleApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $localeIdx = 0; # Integer | Valid top level descriptor index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


eval { 
    my $result = $api_instance->getDescLocale(deviceId => $deviceId, cfgIdx => $cfgIdx, localeIdx => $localeIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LocaleApi->getDescLocale: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.LocaleApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
localeIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

try: 
    # Get locale Descriptor
    api_response = api_instance.get_desc_locale(deviceId, cfgIdx, localeIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LocaleApi->getDescLocale: %s\n" % e)
extern crate LocaleApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let localeIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = LocaleApi::Context::default();
    let result = client.getDescLocale(deviceId, cfgIdx, localeIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
locale_idx*
Integer
Valid top level descriptor index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database

Responses


getDescLocaleStrings

Get Descriptor LOCALE strings


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/locale/{locale_idx}/strings/{string_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/locale/{locale_idx}/strings/{string_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LocaleApi;

import java.io.File;
import java.util.*;

public class LocaleApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        LocaleApi apiInstance = new LocaleApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer localeIdx = 0; // Integer | Descriptor LOCALE index

        Integer stringIdx = 0; // Integer | Descriptor STRINGS index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            STRINGS result = apiInstance.getDescLocaleStrings(deviceId, cfgIdx, localeIdx, stringIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocaleApi#getDescLocaleStrings");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LocaleApi;

public class LocaleApiExample {
    public static void main(String[] args) {
        LocaleApi apiInstance = new LocaleApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer localeIdx = 0; // Integer | Descriptor LOCALE index

        Integer stringIdx = 0; // Integer | Descriptor STRINGS index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            STRINGS result = apiInstance.getDescLocaleStrings(deviceId, cfgIdx, localeIdx, stringIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocaleApi#getDescLocaleStrings");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
LocaleApi *apiInstance = [[LocaleApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *localeIdx = 0; // Descriptor LOCALE index
 (default to null)
Integer *stringIdx = 0; // Descriptor STRINGS index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

// Get Descriptor LOCALE strings
[apiInstance getDescLocaleStringsWith:deviceId
    cfgIdx:cfgIdx
    localeIdx:localeIdx
    stringIdx:stringIdx
    entity:entity
              completionHandler: ^(STRINGS output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.LocaleApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var localeIdx = 0; // {Integer} Descriptor LOCALE index

var stringIdx = 0; // {Integer} Descriptor STRINGS index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescLocaleStrings(deviceId, cfgIdx, localeIdx, stringIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescLocaleStringsExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new LocaleApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var localeIdx = 0;  // Integer | Descriptor LOCALE index
 (default to null)
            var stringIdx = 0;  // Integer | Descriptor STRINGS index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional)  (default to null)

            try {
                // Get Descriptor LOCALE strings
                STRINGS result = apiInstance.getDescLocaleStrings(deviceId, cfgIdx, localeIdx, stringIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LocaleApi.getDescLocaleStrings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LocaleApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$localeIdx = 0; // Integer | Descriptor LOCALE index

$stringIdx = 0; // Integer | Descriptor STRINGS index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


try {
    $result = $api_instance->getDescLocaleStrings($deviceId, $cfgIdx, $localeIdx, $stringIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LocaleApi->getDescLocaleStrings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LocaleApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LocaleApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $localeIdx = 0; # Integer | Descriptor LOCALE index

my $stringIdx = 0; # Integer | Descriptor STRINGS index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


eval { 
    my $result = $api_instance->getDescLocaleStrings(deviceId => $deviceId, cfgIdx => $cfgIdx, localeIdx => $localeIdx, stringIdx => $stringIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LocaleApi->getDescLocaleStrings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.LocaleApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
localeIdx = 0 # Integer | Descriptor LOCALE index
 (default to null)
stringIdx = 0 # Integer | Descriptor STRINGS index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.
  
*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

try: 
    # Get Descriptor LOCALE strings
    api_response = api_instance.get_desc_locale_strings(deviceId, cfgIdx, localeIdx, stringIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LocaleApi->getDescLocaleStrings: %s\n" % e)
extern crate LocaleApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let localeIdx = 0; // Integer
    let stringIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = LocaleApi::Context::default();
    let result = client.getDescLocaleStrings(deviceId, cfgIdx, localeIdx, stringIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
locale_idx*
Integer
Descriptor LOCALE index
Required
string_idx*
Integer
Descriptor STRINGS index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database

Responses


writeDescLocale

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/locale/{locale_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/locale/{locale_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LocaleApi;

import java.io.File;
import java.util.*;

public class LocaleApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        LocaleApi apiInstance = new LocaleApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer localeIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            LOCALE result = apiInstance.writeDescLocale(deviceId, cfgIdx, localeIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocaleApi#writeDescLocale");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LocaleApi;

public class LocaleApiExample {
    public static void main(String[] args) {
        LocaleApi apiInstance = new LocaleApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer localeIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            LOCALE result = apiInstance.writeDescLocale(deviceId, cfgIdx, localeIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocaleApi#writeDescLocale");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
LocaleApi *apiInstance = [[LocaleApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *localeIdx = 0; // Valid top level descriptor index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance writeDescLocaleWith:deviceId
    cfgIdx:cfgIdx
    localeIdx:localeIdx
    length:length
    data:data
              completionHandler: ^(LOCALE output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.LocaleApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var localeIdx = 0; // {Integer} Valid top level descriptor index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescLocale(deviceId, cfgIdx, localeIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescLocaleExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new LocaleApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var localeIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                LOCALE result = apiInstance.writeDescLocale(deviceId, cfgIdx, localeIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LocaleApi.writeDescLocale: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LocaleApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$localeIdx = 0; // Integer | Valid top level descriptor index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescLocale($deviceId, $cfgIdx, $localeIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LocaleApi->writeDescLocale: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LocaleApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LocaleApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $localeIdx = 0; # Integer | Valid top level descriptor index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescLocale(deviceId => $deviceId, cfgIdx => $cfgIdx, localeIdx => $localeIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LocaleApi->writeDescLocale: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.LocaleApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
localeIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.write_desc_locale(deviceId, cfgIdx, localeIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LocaleApi->writeDescLocale: %s\n" % e)
extern crate LocaleApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let localeIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = LocaleApi::Context::default();
    let result = client.writeDescLocale(deviceId, cfgIdx, localeIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
locale_idx*
Integer
Valid top level descriptor index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


writeDescLocaleStrings

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/locale/{locale_idx}/strings/{string_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/locale/{locale_idx}/strings/{string_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LocaleApi;

import java.io.File;
import java.util.*;

public class LocaleApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        LocaleApi apiInstance = new LocaleApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer localeIdx = 0; // Integer | Descriptor LOCALE index

        Integer stringIdx = 0; // Integer | Descriptor STRINGS index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            STRINGS result = apiInstance.writeDescLocaleStrings(deviceId, cfgIdx, localeIdx, stringIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocaleApi#writeDescLocaleStrings");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LocaleApi;

public class LocaleApiExample {
    public static void main(String[] args) {
        LocaleApi apiInstance = new LocaleApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer localeIdx = 0; // Integer | Descriptor LOCALE index

        Integer stringIdx = 0; // Integer | Descriptor STRINGS index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            STRINGS result = apiInstance.writeDescLocaleStrings(deviceId, cfgIdx, localeIdx, stringIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocaleApi#writeDescLocaleStrings");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
LocaleApi *apiInstance = [[LocaleApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *localeIdx = 0; // Descriptor LOCALE index
 (default to null)
Integer *stringIdx = 0; // Descriptor STRINGS index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance writeDescLocaleStringsWith:deviceId
    cfgIdx:cfgIdx
    localeIdx:localeIdx
    stringIdx:stringIdx
    length:length
    data:data
              completionHandler: ^(STRINGS output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.LocaleApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var localeIdx = 0; // {Integer} Descriptor LOCALE index

var stringIdx = 0; // {Integer} Descriptor STRINGS index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescLocaleStrings(deviceId, cfgIdx, localeIdx, stringIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescLocaleStringsExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new LocaleApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var localeIdx = 0;  // Integer | Descriptor LOCALE index
 (default to null)
            var stringIdx = 0;  // Integer | Descriptor STRINGS index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                STRINGS result = apiInstance.writeDescLocaleStrings(deviceId, cfgIdx, localeIdx, stringIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LocaleApi.writeDescLocaleStrings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LocaleApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$localeIdx = 0; // Integer | Descriptor LOCALE index

$stringIdx = 0; // Integer | Descriptor STRINGS index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescLocaleStrings($deviceId, $cfgIdx, $localeIdx, $stringIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LocaleApi->writeDescLocaleStrings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LocaleApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LocaleApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $localeIdx = 0; # Integer | Descriptor LOCALE index

my $stringIdx = 0; # Integer | Descriptor STRINGS index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescLocaleStrings(deviceId => $deviceId, cfgIdx => $cfgIdx, localeIdx => $localeIdx, stringIdx => $stringIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LocaleApi->writeDescLocaleStrings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.LocaleApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
localeIdx = 0 # Integer | Descriptor LOCALE index
 (default to null)
stringIdx = 0 # Integer | Descriptor STRINGS index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.write_desc_locale_strings(deviceId, cfgIdx, localeIdx, stringIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LocaleApi->writeDescLocaleStrings: %s\n" % e)
extern crate LocaleApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let localeIdx = 0; // Integer
    let stringIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = LocaleApi::Context::default();
    let result = client.writeDescLocaleStrings(deviceId, cfgIdx, localeIdx, stringIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
locale_idx*
Integer
Descriptor LOCALE index
Required
string_idx*
Integer
Descriptor STRINGS index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


Matrix

getDescMatrix

Get matrix Descriptor


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/matrix/{matrix_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/matrix/{matrix_idx}?entity=®ion=&format="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MatrixApi;

import java.io.File;
import java.util.*;

public class MatrixApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        MatrixApi apiInstance = new MatrixApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer matrixIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        Region2 region = ; // Region2 | The **GET_MATRIX** command is used to get the current values of a Control point in the Matrix. 
It can be used to get the values of Matrix or a values of a subregion of a Matrix horizontally or vertically. 
The get_matrix command returns the values for the currently active Configuration.

        Format8 format = ; // Format8 | specific value Control Value 

        
        try {
            MATRIX result = apiInstance.getDescMatrix(deviceId, cfgIdx, matrixIdx, entity, region, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MatrixApi#getDescMatrix");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MatrixApi;

public class MatrixApiExample {
    public static void main(String[] args) {
        MatrixApi apiInstance = new MatrixApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer matrixIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        Region2 region = ; // Region2 | The **GET_MATRIX** command is used to get the current values of a Control point in the Matrix. 
It can be used to get the values of Matrix or a values of a subregion of a Matrix horizontally or vertically. 
The get_matrix command returns the values for the currently active Configuration.

        Format8 format = ; // Format8 | specific value Control Value 

        
        try {
            MATRIX result = apiInstance.getDescMatrix(deviceId, cfgIdx, matrixIdx, entity, region, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MatrixApi#getDescMatrix");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MatrixApi *apiInstance = [[MatrixApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *matrixIdx = 0; // Valid top level descriptor index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)
Region2 *region = ; // The **GET_MATRIX** command is used to get the current values of a Control point in the Matrix. 
It can be used to get the values of Matrix or a values of a subregion of a Matrix horizontally or vertically. 
The get_matrix command returns the values for the currently active Configuration.
 (optional) (default to null)
Format8 *format = ; // specific value Control Value 
 (optional) (default to null)

// Get matrix Descriptor
[apiInstance getDescMatrixWith:deviceId
    cfgIdx:cfgIdx
    matrixIdx:matrixIdx
    entity:entity
    region:region
    format:format
              completionHandler: ^(MATRIX output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.MatrixApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var matrixIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'entity': , // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

  'region': , // {Region2} The **GET_MATRIX** command is used to get the current values of a Control point in the Matrix. 
It can be used to get the values of Matrix or a values of a subregion of a Matrix horizontally or vertically. 
The get_matrix command returns the values for the currently active Configuration.

  'format':  // {Format8} specific value Control Value 

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescMatrix(deviceId, cfgIdx, matrixIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescMatrixExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new MatrixApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var matrixIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional)  (default to null)
            var region = new Region2(); // Region2 | The **GET_MATRIX** command is used to get the current values of a Control point in the Matrix. 
It can be used to get the values of Matrix or a values of a subregion of a Matrix horizontally or vertically. 
The get_matrix command returns the values for the currently active Configuration.
 (optional)  (default to null)
            var format = new Format8(); // Format8 | specific value Control Value 
 (optional)  (default to null)

            try {
                // Get matrix Descriptor
                MATRIX result = apiInstance.getDescMatrix(deviceId, cfgIdx, matrixIdx, entity, region, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MatrixApi.getDescMatrix: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MatrixApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$matrixIdx = 0; // Integer | Valid top level descriptor index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

$region = ; // Region2 | The **GET_MATRIX** command is used to get the current values of a Control point in the Matrix. 
It can be used to get the values of Matrix or a values of a subregion of a Matrix horizontally or vertically. 
The get_matrix command returns the values for the currently active Configuration.

$format = ; // Format8 | specific value Control Value 


try {
    $result = $api_instance->getDescMatrix($deviceId, $cfgIdx, $matrixIdx, $entity, $region, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MatrixApi->getDescMatrix: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MatrixApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MatrixApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $matrixIdx = 0; # Integer | Valid top level descriptor index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

my $region = ; # Region2 | The **GET_MATRIX** command is used to get the current values of a Control point in the Matrix. 
It can be used to get the values of Matrix or a values of a subregion of a Matrix horizontally or vertically. 
The get_matrix command returns the values for the currently active Configuration.

my $format = ; # Format8 | specific value Control Value 


eval { 
    my $result = $api_instance->getDescMatrix(deviceId => $deviceId, cfgIdx => $cfgIdx, matrixIdx => $matrixIdx, entity => $entity, region => $region, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MatrixApi->getDescMatrix: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.MatrixApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
matrixIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)
region =  # Region2 | The **GET_MATRIX** command is used to get the current values of a Control point in the Matrix. 
It can be used to get the values of Matrix or a values of a subregion of a Matrix horizontally or vertically. 
The get_matrix command returns the values for the currently active Configuration.
 (optional) (default to null)
format =  # Format8 | specific value Control Value 
 (optional) (default to null)

try: 
    # Get matrix Descriptor
    api_response = api_instance.get_desc_matrix(deviceId, cfgIdx, matrixIdx, entity=entity, region=region, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MatrixApi->getDescMatrix: %s\n" % e)
extern crate MatrixApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let matrixIdx = 0; // Integer
    let entity = ; // array[String]
    let region = ; // Region2
    let format = ; // Format8

    let mut context = MatrixApi::Context::default();
    let result = client.getDescMatrix(deviceId, cfgIdx, matrixIdx, entity, region, format, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
matrix_idx*
Integer
Valid top level descriptor index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
region
Region2
The **GET_MATRIX** command is used to get the current values of a Control point in the Matrix. It can be used to get the values of Matrix or a values of a subregion of a Matrix horizontally or vertically. The get_matrix command returns the values for the currently active Configuration.
format
Format8
specific value Control Value

Responses


modifyDescMatrix

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command. *region* The **SET_MATRIX** command acts on a MATRIX descriptor in the current Configuration. An Entity may propagate the Matrix value changes onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. It can be used to fill a Matrix or a subregion of a Matrix horizontally or vertically with: * The same repeating value * list of repeating values A list of non-repeating values * A list non-repeating values spanning more than one **SET_MATRIX** command


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/matrix/{matrix_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/matrix/{matrix_idx}?region="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MatrixApi;

import java.io.File;
import java.util.*;

public class MatrixApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        MatrixApi apiInstance = new MatrixApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer matrixIdx = 0; // Integer | Valid top level descriptor index

        Region3 region = ; // Region3 | get Matrix Control Values

        MATRIX1 mATRIX1 = {MATRIX={objectName=Matrix 0}}; // MATRIX1 | 
        
        try {
            MATRIX result = apiInstance.modifyDescMatrix(deviceId, cfgIdx, matrixIdx, region, mATRIX1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MatrixApi#modifyDescMatrix");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MatrixApi;

public class MatrixApiExample {
    public static void main(String[] args) {
        MatrixApi apiInstance = new MatrixApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer matrixIdx = 0; // Integer | Valid top level descriptor index

        Region3 region = ; // Region3 | get Matrix Control Values

        MATRIX1 mATRIX1 = {MATRIX={objectName=Matrix 0}}; // MATRIX1 | 
        
        try {
            MATRIX result = apiInstance.modifyDescMatrix(deviceId, cfgIdx, matrixIdx, region, mATRIX1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MatrixApi#modifyDescMatrix");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MatrixApi *apiInstance = [[MatrixApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *matrixIdx = 0; // Valid top level descriptor index
 (default to null)
Region3 *region = ; // get Matrix Control Values
 (optional) (default to null)
MATRIX1 *mATRIX1 = {MATRIX={objectName=Matrix 0}}; //  (optional)

// modify Descriptor variable Values
[apiInstance modifyDescMatrixWith:deviceId
    cfgIdx:cfgIdx
    matrixIdx:matrixIdx
    region:region
    mATRIX1:mATRIX1
              completionHandler: ^(MATRIX output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.MatrixApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var matrixIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'region': , // {Region3} get Matrix Control Values

  'mATRIX1': {MATRIX={objectName=Matrix 0}} // {MATRIX1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyDescMatrix(deviceId, cfgIdx, matrixIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyDescMatrixExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new MatrixApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var matrixIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var region = new Region3(); // Region3 | get Matrix Control Values
 (optional)  (default to null)
            var mATRIX1 = new MATRIX1(); // MATRIX1 |  (optional) 

            try {
                // modify Descriptor variable Values
                MATRIX result = apiInstance.modifyDescMatrix(deviceId, cfgIdx, matrixIdx, region, mATRIX1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MatrixApi.modifyDescMatrix: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MatrixApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$matrixIdx = 0; // Integer | Valid top level descriptor index

$region = ; // Region3 | get Matrix Control Values

$mATRIX1 = {MATRIX={objectName=Matrix 0}}; // MATRIX1 | 

try {
    $result = $api_instance->modifyDescMatrix($deviceId, $cfgIdx, $matrixIdx, $region, $mATRIX1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MatrixApi->modifyDescMatrix: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MatrixApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MatrixApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $matrixIdx = 0; # Integer | Valid top level descriptor index

my $region = ; # Region3 | get Matrix Control Values

my $mATRIX1 = WWW::OPenAPIClient::Object::MATRIX1->new(); # MATRIX1 | 

eval { 
    my $result = $api_instance->modifyDescMatrix(deviceId => $deviceId, cfgIdx => $cfgIdx, matrixIdx => $matrixIdx, region => $region, mATRIX1 => $mATRIX1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MatrixApi->modifyDescMatrix: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.MatrixApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
matrixIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
region =  # Region3 | get Matrix Control Values
 (optional) (default to null)
mATRIX1 = {MATRIX={objectName=Matrix 0}} # MATRIX1 |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.modify_desc_matrix(deviceId, cfgIdx, matrixIdx, region=region, mATRIX1=mATRIX1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MatrixApi->modifyDescMatrix: %s\n" % e)
extern crate MatrixApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let matrixIdx = 0; // Integer
    let region = ; // Region3
    let mATRIX1 = {MATRIX={objectName=Matrix 0}}; // MATRIX1

    let mut context = MatrixApi::Context::default();
    let result = client.modifyDescMatrix(deviceId, cfgIdx, matrixIdx, region, mATRIX1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
matrix_idx*
Integer
Valid top level descriptor index
Required
Body parameters
Name Description
mATRIX1

Set Object Name and Control Value

Query parameters
Name Description
region
Region3
get Matrix Control Values

Responses


writeDescMatrix

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/matrix/{matrix_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/matrix/{matrix_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MatrixApi;

import java.io.File;
import java.util.*;

public class MatrixApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        MatrixApi apiInstance = new MatrixApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer matrixIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            MATRIX result = apiInstance.writeDescMatrix(deviceId, cfgIdx, matrixIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MatrixApi#writeDescMatrix");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MatrixApi;

public class MatrixApiExample {
    public static void main(String[] args) {
        MatrixApi apiInstance = new MatrixApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer matrixIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            MATRIX result = apiInstance.writeDescMatrix(deviceId, cfgIdx, matrixIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MatrixApi#writeDescMatrix");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MatrixApi *apiInstance = [[MatrixApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *matrixIdx = 0; // Valid top level descriptor index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance writeDescMatrixWith:deviceId
    cfgIdx:cfgIdx
    matrixIdx:matrixIdx
    length:length
    data:data
              completionHandler: ^(MATRIX output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.MatrixApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var matrixIdx = 0; // {Integer} Valid top level descriptor index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescMatrix(deviceId, cfgIdx, matrixIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescMatrixExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new MatrixApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var matrixIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                MATRIX result = apiInstance.writeDescMatrix(deviceId, cfgIdx, matrixIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MatrixApi.writeDescMatrix: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MatrixApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$matrixIdx = 0; // Integer | Valid top level descriptor index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescMatrix($deviceId, $cfgIdx, $matrixIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MatrixApi->writeDescMatrix: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MatrixApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MatrixApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $matrixIdx = 0; # Integer | Valid top level descriptor index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescMatrix(deviceId => $deviceId, cfgIdx => $cfgIdx, matrixIdx => $matrixIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MatrixApi->writeDescMatrix: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.MatrixApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
matrixIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.write_desc_matrix(deviceId, cfgIdx, matrixIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MatrixApi->writeDescMatrix: %s\n" % e)
extern crate MatrixApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let matrixIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = MatrixApi::Context::default();
    let result = client.writeDescMatrix(deviceId, cfgIdx, matrixIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
matrix_idx*
Integer
Valid top level descriptor index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


MatrixSignal

getDescMatrixSignal

Get matrixSignal Descriptor


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/matrixSignal/{signal_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/matrixSignal/{signal_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MatrixSignalApi;

import java.io.File;
import java.util.*;

public class MatrixSignalApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        MatrixSignalApi apiInstance = new MatrixSignalApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer signalIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            MATRIX_SIGNAL result = apiInstance.getDescMatrixSignal(deviceId, cfgIdx, signalIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MatrixSignalApi#getDescMatrixSignal");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MatrixSignalApi;

public class MatrixSignalApiExample {
    public static void main(String[] args) {
        MatrixSignalApi apiInstance = new MatrixSignalApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer signalIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

        
        try {
            MATRIX_SIGNAL result = apiInstance.getDescMatrixSignal(deviceId, cfgIdx, signalIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MatrixSignalApi#getDescMatrixSignal");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MatrixSignalApi *apiInstance = [[MatrixSignalApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *signalIdx = 0; // Valid top level descriptor index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

// Get matrixSignal Descriptor
[apiInstance getDescMatrixSignalWith:deviceId
    cfgIdx:cfgIdx
    signalIdx:signalIdx
    entity:entity
              completionHandler: ^(MATRIX_SIGNAL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.MatrixSignalApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var signalIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescMatrixSignal(deviceId, cfgIdx, signalIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescMatrixSignalExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new MatrixSignalApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var signalIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional)  (default to null)

            try {
                // Get matrixSignal Descriptor
                MATRIX_SIGNAL result = apiInstance.getDescMatrixSignal(deviceId, cfgIdx, signalIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MatrixSignalApi.getDescMatrixSignal: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MatrixSignalApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$signalIdx = 0; // Integer | Valid top level descriptor index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


try {
    $result = $api_instance->getDescMatrixSignal($deviceId, $cfgIdx, $signalIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MatrixSignalApi->getDescMatrixSignal: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MatrixSignalApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MatrixSignalApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $signalIdx = 0; # Integer | Valid top level descriptor index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database


eval { 
    my $result = $api_instance->getDescMatrixSignal(deviceId => $deviceId, cfgIdx => $cfgIdx, signalIdx => $signalIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MatrixSignalApi->getDescMatrixSignal: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.MatrixSignalApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
signalIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database
 (optional) (default to null)

try: 
    # Get matrixSignal Descriptor
    api_response = api_instance.get_desc_matrix_signal(deviceId, cfgIdx, signalIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MatrixSignalApi->getDescMatrixSignal: %s\n" % e)
extern crate MatrixSignalApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let signalIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = MatrixSignalApi::Context::default();
    let result = client.getDescMatrixSignal(deviceId, cfgIdx, signalIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
signal_idx*
Integer
Valid top level descriptor index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database

Responses


writeDescMatrixSignal

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/matrixSignal/{signal_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/matrixSignal/{signal_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MatrixSignalApi;

import java.io.File;
import java.util.*;

public class MatrixSignalApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        MatrixSignalApi apiInstance = new MatrixSignalApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer signalIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            MATRIX_SIGNAL result = apiInstance.writeDescMatrixSignal(deviceId, cfgIdx, signalIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MatrixSignalApi#writeDescMatrixSignal");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MatrixSignalApi;

public class MatrixSignalApiExample {
    public static void main(String[] args) {
        MatrixSignalApi apiInstance = new MatrixSignalApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer signalIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            MATRIX_SIGNAL result = apiInstance.writeDescMatrixSignal(deviceId, cfgIdx, signalIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MatrixSignalApi#writeDescMatrixSignal");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MatrixSignalApi *apiInstance = [[MatrixSignalApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *signalIdx = 0; // Valid top level descriptor index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance writeDescMatrixSignalWith:deviceId
    cfgIdx:cfgIdx
    signalIdx:signalIdx
    length:length
    data:data
              completionHandler: ^(MATRIX_SIGNAL output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.MatrixSignalApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var signalIdx = 0; // {Integer} Valid top level descriptor index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescMatrixSignal(deviceId, cfgIdx, signalIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescMatrixSignalExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new MatrixSignalApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var signalIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                MATRIX_SIGNAL result = apiInstance.writeDescMatrixSignal(deviceId, cfgIdx, signalIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MatrixSignalApi.writeDescMatrixSignal: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MatrixSignalApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$signalIdx = 0; // Integer | Valid top level descriptor index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescMatrixSignal($deviceId, $cfgIdx, $signalIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MatrixSignalApi->writeDescMatrixSignal: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MatrixSignalApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MatrixSignalApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $signalIdx = 0; # Integer | Valid top level descriptor index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescMatrixSignal(deviceId => $deviceId, cfgIdx => $cfgIdx, signalIdx => $signalIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MatrixSignalApi->writeDescMatrixSignal: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.MatrixSignalApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
signalIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.write_desc_matrix_signal(deviceId, cfgIdx, signalIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MatrixSignalApi->writeDescMatrixSignal: %s\n" % e)
extern crate MatrixSignalApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let signalIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = MatrixSignalApi::Context::default();
    let result = client.writeDescMatrixSignal(deviceId, cfgIdx, signalIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
signal_idx*
Integer
Valid top level descriptor index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


MemoryObject

delMemoryObjectOperation

Delete all Operations


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/memoryObject/{obj_idx}/operation

Usage and SDK Samples

curl -X DELETE\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/memoryObject/{obj_idx}/operation"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MemoryObjectApi;

import java.io.File;
import java.util.*;

public class MemoryObjectApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        MemoryObjectApi apiInstance = new MemoryObjectApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer objIdx = 0; // Integer | Valid top level descriptor index

        
        try {
            inline_response_200_12 result = apiInstance.delMemoryObjectOperation(deviceId, cfgIdx, objIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MemoryObjectApi#delMemoryObjectOperation");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MemoryObjectApi;

public class MemoryObjectApiExample {
    public static void main(String[] args) {
        MemoryObjectApi apiInstance = new MemoryObjectApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer objIdx = 0; // Integer | Valid top level descriptor index

        
        try {
            inline_response_200_12 result = apiInstance.delMemoryObjectOperation(deviceId, cfgIdx, objIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MemoryObjectApi#delMemoryObjectOperation");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MemoryObjectApi *apiInstance = [[MemoryObjectApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *objIdx = 0; // Valid top level descriptor index
 (default to null)

// Delete all Operations
[apiInstance delMemoryObjectOperationWith:deviceId
    cfgIdx:cfgIdx
    objIdx:objIdx
              completionHandler: ^(inline_response_200_12 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.MemoryObjectApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var objIdx = 0; // {Integer} Valid top level descriptor index


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.delMemoryObjectOperation(deviceId, cfgIdx, objIdx, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class delMemoryObjectOperationExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new MemoryObjectApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var objIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)

            try {
                // Delete all Operations
                inline_response_200_12 result = apiInstance.delMemoryObjectOperation(deviceId, cfgIdx, objIdx);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MemoryObjectApi.delMemoryObjectOperation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MemoryObjectApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$objIdx = 0; // Integer | Valid top level descriptor index


try {
    $result = $api_instance->delMemoryObjectOperation($deviceId, $cfgIdx, $objIdx);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MemoryObjectApi->delMemoryObjectOperation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MemoryObjectApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MemoryObjectApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $objIdx = 0; # Integer | Valid top level descriptor index


eval { 
    my $result = $api_instance->delMemoryObjectOperation(deviceId => $deviceId, cfgIdx => $cfgIdx, objIdx => $objIdx);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MemoryObjectApi->delMemoryObjectOperation: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.MemoryObjectApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
objIdx = 0 # Integer | Valid top level descriptor index
 (default to null)

try: 
    # Delete all Operations
    api_response = api_instance.del_memory_object_operation(deviceId, cfgIdx, objIdx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MemoryObjectApi->delMemoryObjectOperation: %s\n" % e)
extern crate MemoryObjectApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let objIdx = 0; // Integer

    let mut context = MemoryObjectApi::Context::default();
    let result = client.delMemoryObjectOperation(deviceId, cfgIdx, objIdx, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
obj_idx*
Integer
Valid top level descriptor index
Required

Responses


delMemoryObjectOperationStatus

Delete Operations


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/memoryObject/{obj_idx}/operation/{operations_idx}

Usage and SDK Samples

curl -X DELETE\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/memoryObject/{obj_idx}/operation/{operations_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MemoryObjectApi;

import java.io.File;
import java.util.*;

public class MemoryObjectApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        MemoryObjectApi apiInstance = new MemoryObjectApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer objIdx = 0; // Integer | Valid top level descriptor index

        Integer operationsIdx = 1234; // Integer | Operations identifier

        
        try {
            inline_response_200_12 result = apiInstance.delMemoryObjectOperationStatus(deviceId, cfgIdx, objIdx, operationsIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MemoryObjectApi#delMemoryObjectOperationStatus");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MemoryObjectApi;

public class MemoryObjectApiExample {
    public static void main(String[] args) {
        MemoryObjectApi apiInstance = new MemoryObjectApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer objIdx = 0; // Integer | Valid top level descriptor index

        Integer operationsIdx = 1234; // Integer | Operations identifier

        
        try {
            inline_response_200_12 result = apiInstance.delMemoryObjectOperationStatus(deviceId, cfgIdx, objIdx, operationsIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MemoryObjectApi#delMemoryObjectOperationStatus");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MemoryObjectApi *apiInstance = [[MemoryObjectApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *objIdx = 0; // Valid top level descriptor index
 (default to null)
Integer *operationsIdx = 1234; // Operations identifier
 (default to null)

// Delete Operations
[apiInstance delMemoryObjectOperationStatusWith:deviceId
    cfgIdx:cfgIdx
    objIdx:objIdx
    operationsIdx:operationsIdx
              completionHandler: ^(inline_response_200_12 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.MemoryObjectApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var objIdx = 0; // {Integer} Valid top level descriptor index

var operationsIdx = 1234; // {Integer} Operations identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.delMemoryObjectOperationStatus(deviceId, cfgIdx, objIdx, operationsIdx, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class delMemoryObjectOperationStatusExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new MemoryObjectApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var objIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var operationsIdx = 1234;  // Integer | Operations identifier
 (default to null)

            try {
                // Delete Operations
                inline_response_200_12 result = apiInstance.delMemoryObjectOperationStatus(deviceId, cfgIdx, objIdx, operationsIdx);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MemoryObjectApi.delMemoryObjectOperationStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MemoryObjectApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$objIdx = 0; // Integer | Valid top level descriptor index

$operationsIdx = 1234; // Integer | Operations identifier


try {
    $result = $api_instance->delMemoryObjectOperationStatus($deviceId, $cfgIdx, $objIdx, $operationsIdx);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MemoryObjectApi->delMemoryObjectOperationStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MemoryObjectApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MemoryObjectApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $objIdx = 0; # Integer | Valid top level descriptor index

my $operationsIdx = 1234; # Integer | Operations identifier


eval { 
    my $result = $api_instance->delMemoryObjectOperationStatus(deviceId => $deviceId, cfgIdx => $cfgIdx, objIdx => $objIdx, operationsIdx => $operationsIdx);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MemoryObjectApi->delMemoryObjectOperationStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.MemoryObjectApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
objIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
operationsIdx = 1234 # Integer | Operations identifier
 (default to null)

try: 
    # Delete Operations
    api_response = api_instance.del_memory_object_operation_status(deviceId, cfgIdx, objIdx, operationsIdx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MemoryObjectApi->delMemoryObjectOperationStatus: %s\n" % e)
extern crate MemoryObjectApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let objIdx = 0; // Integer
    let operationsIdx = 1234; // Integer

    let mut context = MemoryObjectApi::Context::default();
    let result = client.delMemoryObjectOperationStatus(deviceId, cfgIdx, objIdx, operationsIdx, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
obj_idx*
Integer
Valid top level descriptor index
Required
operations_idx*
Integer
Operations identifier
Required

Responses


getDescMemoryObject

Get memoryObject Descriptor


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/memoryObject/{obj_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/memoryObject/{obj_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MemoryObjectApi;

import java.io.File;
import java.util.*;

public class MemoryObjectApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        MemoryObjectApi apiInstance = new MemoryObjectApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer objIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*length* The **GET_MEMORY_OBJECT_LENGTH** command is used to get the length field of a MEMORY_OBJECT descriptor. 
The get_memoryObjectLength command may be protected by authentication. 
If this is the case, then the Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller. 
If length is greater than the Memory Object’s maximum_length field, then an error code of BAD_ARGUMENTS status response to the Controller.

        
        try {
            MEMORY_OBJECT result = apiInstance.getDescMemoryObject(deviceId, cfgIdx, objIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MemoryObjectApi#getDescMemoryObject");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MemoryObjectApi;

public class MemoryObjectApiExample {
    public static void main(String[] args) {
        MemoryObjectApi apiInstance = new MemoryObjectApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer objIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*length* The **GET_MEMORY_OBJECT_LENGTH** command is used to get the length field of a MEMORY_OBJECT descriptor. 
The get_memoryObjectLength command may be protected by authentication. 
If this is the case, then the Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller. 
If length is greater than the Memory Object’s maximum_length field, then an error code of BAD_ARGUMENTS status response to the Controller.

        
        try {
            MEMORY_OBJECT result = apiInstance.getDescMemoryObject(deviceId, cfgIdx, objIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MemoryObjectApi#getDescMemoryObject");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MemoryObjectApi *apiInstance = [[MemoryObjectApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *objIdx = 0; // Valid top level descriptor index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*length* The **GET_MEMORY_OBJECT_LENGTH** command is used to get the length field of a MEMORY_OBJECT descriptor. 
The get_memoryObjectLength command may be protected by authentication. 
If this is the case, then the Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller. 
If length is greater than the Memory Object’s maximum_length field, then an error code of BAD_ARGUMENTS status response to the Controller.
 (optional) (default to null)

// Get memoryObject Descriptor
[apiInstance getDescMemoryObjectWith:deviceId
    cfgIdx:cfgIdx
    objIdx:objIdx
    entity:entity
              completionHandler: ^(MEMORY_OBJECT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.MemoryObjectApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var objIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*length* The **GET_MEMORY_OBJECT_LENGTH** command is used to get the length field of a MEMORY_OBJECT descriptor. 
The get_memoryObjectLength command may be protected by authentication. 
If this is the case, then the Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller. 
If length is greater than the Memory Object’s maximum_length field, then an error code of BAD_ARGUMENTS status response to the Controller.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescMemoryObject(deviceId, cfgIdx, objIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescMemoryObjectExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new MemoryObjectApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var objIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*length* The **GET_MEMORY_OBJECT_LENGTH** command is used to get the length field of a MEMORY_OBJECT descriptor. 
The get_memoryObjectLength command may be protected by authentication. 
If this is the case, then the Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller. 
If length is greater than the Memory Object’s maximum_length field, then an error code of BAD_ARGUMENTS status response to the Controller.
 (optional)  (default to null)

            try {
                // Get memoryObject Descriptor
                MEMORY_OBJECT result = apiInstance.getDescMemoryObject(deviceId, cfgIdx, objIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MemoryObjectApi.getDescMemoryObject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MemoryObjectApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$objIdx = 0; // Integer | Valid top level descriptor index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*length* The **GET_MEMORY_OBJECT_LENGTH** command is used to get the length field of a MEMORY_OBJECT descriptor. 
The get_memoryObjectLength command may be protected by authentication. 
If this is the case, then the Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller. 
If length is greater than the Memory Object’s maximum_length field, then an error code of BAD_ARGUMENTS status response to the Controller.


try {
    $result = $api_instance->getDescMemoryObject($deviceId, $cfgIdx, $objIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MemoryObjectApi->getDescMemoryObject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MemoryObjectApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MemoryObjectApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $objIdx = 0; # Integer | Valid top level descriptor index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*length* The **GET_MEMORY_OBJECT_LENGTH** command is used to get the length field of a MEMORY_OBJECT descriptor. 
The get_memoryObjectLength command may be protected by authentication. 
If this is the case, then the Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller. 
If length is greater than the Memory Object’s maximum_length field, then an error code of BAD_ARGUMENTS status response to the Controller.


eval { 
    my $result = $api_instance->getDescMemoryObject(deviceId => $deviceId, cfgIdx => $cfgIdx, objIdx => $objIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MemoryObjectApi->getDescMemoryObject: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.MemoryObjectApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
objIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*length* The **GET_MEMORY_OBJECT_LENGTH** command is used to get the length field of a MEMORY_OBJECT descriptor. 
The get_memoryObjectLength command may be protected by authentication. 
If this is the case, then the Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller. 
If length is greater than the Memory Object’s maximum_length field, then an error code of BAD_ARGUMENTS status response to the Controller.
 (optional) (default to null)

try: 
    # Get memoryObject Descriptor
    api_response = api_instance.get_desc_memory_object(deviceId, cfgIdx, objIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MemoryObjectApi->getDescMemoryObject: %s\n" % e)
extern crate MemoryObjectApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let objIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = MemoryObjectApi::Context::default();
    let result = client.getDescMemoryObject(deviceId, cfgIdx, objIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
obj_idx*
Integer
Valid top level descriptor index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on. *length* The **GET_MEMORY_OBJECT_LENGTH** command is used to get the length field of a MEMORY_OBJECT descriptor. The get_memoryObjectLength command may be protected by authentication. If this is the case, then the Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller. If length is greater than the Memory Object’s maximum_length field, then an error code of BAD_ARGUMENTS status response to the Controller.

Responses


getMemoryObjectOperation

Get operationslist on memoryObject


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/memoryObject/{obj_idx}/operation

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/memoryObject/{obj_idx}/operation"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MemoryObjectApi;

import java.io.File;
import java.util.*;

public class MemoryObjectApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        MemoryObjectApi apiInstance = new MemoryObjectApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer objIdx = 0; // Integer | Valid top level descriptor index

        
        try {
            inline_response_200_20 result = apiInstance.getMemoryObjectOperation(deviceId, cfgIdx, objIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MemoryObjectApi#getMemoryObjectOperation");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MemoryObjectApi;

public class MemoryObjectApiExample {
    public static void main(String[] args) {
        MemoryObjectApi apiInstance = new MemoryObjectApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer objIdx = 0; // Integer | Valid top level descriptor index

        
        try {
            inline_response_200_20 result = apiInstance.getMemoryObjectOperation(deviceId, cfgIdx, objIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MemoryObjectApi#getMemoryObjectOperation");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MemoryObjectApi *apiInstance = [[MemoryObjectApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *objIdx = 0; // Valid top level descriptor index
 (default to null)

// Get operationslist on memoryObject
[apiInstance getMemoryObjectOperationWith:deviceId
    cfgIdx:cfgIdx
    objIdx:objIdx
              completionHandler: ^(inline_response_200_20 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.MemoryObjectApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var objIdx = 0; // {Integer} Valid top level descriptor index


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMemoryObjectOperation(deviceId, cfgIdx, objIdx, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getMemoryObjectOperationExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new MemoryObjectApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var objIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)

            try {
                // Get operationslist on memoryObject
                inline_response_200_20 result = apiInstance.getMemoryObjectOperation(deviceId, cfgIdx, objIdx);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MemoryObjectApi.getMemoryObjectOperation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MemoryObjectApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$objIdx = 0; // Integer | Valid top level descriptor index


try {
    $result = $api_instance->getMemoryObjectOperation($deviceId, $cfgIdx, $objIdx);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MemoryObjectApi->getMemoryObjectOperation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MemoryObjectApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MemoryObjectApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $objIdx = 0; # Integer | Valid top level descriptor index


eval { 
    my $result = $api_instance->getMemoryObjectOperation(deviceId => $deviceId, cfgIdx => $cfgIdx, objIdx => $objIdx);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MemoryObjectApi->getMemoryObjectOperation: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.MemoryObjectApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
objIdx = 0 # Integer | Valid top level descriptor index
 (default to null)

try: 
    # Get operationslist on memoryObject
    api_response = api_instance.get_memory_object_operation(deviceId, cfgIdx, objIdx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MemoryObjectApi->getMemoryObjectOperation: %s\n" % e)
extern crate MemoryObjectApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let objIdx = 0; // Integer

    let mut context = MemoryObjectApi::Context::default();
    let result = client.getMemoryObjectOperation(deviceId, cfgIdx, objIdx, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
obj_idx*
Integer
Valid top level descriptor index
Required

Responses


getMemoryObjectOperationStatus

Get operations status


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/memoryObject/{obj_idx}/operation/{operations_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/memoryObject/{obj_idx}/operation/{operations_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MemoryObjectApi;

import java.io.File;
import java.util.*;

public class MemoryObjectApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        MemoryObjectApi apiInstance = new MemoryObjectApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer objIdx = 0; // Integer | Valid top level descriptor index

        Integer operationsIdx = 1234; // Integer | Operations identifier

        
        try {
            inline_response_200_21 result = apiInstance.getMemoryObjectOperationStatus(deviceId, cfgIdx, objIdx, operationsIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MemoryObjectApi#getMemoryObjectOperationStatus");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MemoryObjectApi;

public class MemoryObjectApiExample {
    public static void main(String[] args) {
        MemoryObjectApi apiInstance = new MemoryObjectApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer objIdx = 0; // Integer | Valid top level descriptor index

        Integer operationsIdx = 1234; // Integer | Operations identifier

        
        try {
            inline_response_200_21 result = apiInstance.getMemoryObjectOperationStatus(deviceId, cfgIdx, objIdx, operationsIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MemoryObjectApi#getMemoryObjectOperationStatus");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MemoryObjectApi *apiInstance = [[MemoryObjectApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *objIdx = 0; // Valid top level descriptor index
 (default to null)
Integer *operationsIdx = 1234; // Operations identifier
 (default to null)

// Get operations status
[apiInstance getMemoryObjectOperationStatusWith:deviceId
    cfgIdx:cfgIdx
    objIdx:objIdx
    operationsIdx:operationsIdx
              completionHandler: ^(inline_response_200_21 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.MemoryObjectApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var objIdx = 0; // {Integer} Valid top level descriptor index

var operationsIdx = 1234; // {Integer} Operations identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMemoryObjectOperationStatus(deviceId, cfgIdx, objIdx, operationsIdx, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getMemoryObjectOperationStatusExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new MemoryObjectApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var objIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var operationsIdx = 1234;  // Integer | Operations identifier
 (default to null)

            try {
                // Get operations status
                inline_response_200_21 result = apiInstance.getMemoryObjectOperationStatus(deviceId, cfgIdx, objIdx, operationsIdx);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MemoryObjectApi.getMemoryObjectOperationStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MemoryObjectApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$objIdx = 0; // Integer | Valid top level descriptor index

$operationsIdx = 1234; // Integer | Operations identifier


try {
    $result = $api_instance->getMemoryObjectOperationStatus($deviceId, $cfgIdx, $objIdx, $operationsIdx);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MemoryObjectApi->getMemoryObjectOperationStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MemoryObjectApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MemoryObjectApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $objIdx = 0; # Integer | Valid top level descriptor index

my $operationsIdx = 1234; # Integer | Operations identifier


eval { 
    my $result = $api_instance->getMemoryObjectOperationStatus(deviceId => $deviceId, cfgIdx => $cfgIdx, objIdx => $objIdx, operationsIdx => $operationsIdx);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MemoryObjectApi->getMemoryObjectOperationStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.MemoryObjectApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
objIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
operationsIdx = 1234 # Integer | Operations identifier
 (default to null)

try: 
    # Get operations status
    api_response = api_instance.get_memory_object_operation_status(deviceId, cfgIdx, objIdx, operationsIdx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MemoryObjectApi->getMemoryObjectOperationStatus: %s\n" % e)
extern crate MemoryObjectApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let objIdx = 0; // Integer
    let operationsIdx = 1234; // Integer

    let mut context = MemoryObjectApi::Context::default();
    let result = client.getMemoryObjectOperationStatus(deviceId, cfgIdx, objIdx, operationsIdx, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
obj_idx*
Integer
Valid top level descriptor index
Required
operations_idx*
Integer
Operations identifier
Required

Responses


modifyDescMemoryObject

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/memoryObject/{obj_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/memoryObject/{obj_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MemoryObjectApi;

import java.io.File;
import java.util.*;

public class MemoryObjectApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        MemoryObjectApi apiInstance = new MemoryObjectApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer objIdx = 0; // Integer | Valid top level descriptor index

        MEMORYOBJECT1 mEMORYOBJECT1 = {MEMORY_OBJECT={objectName=Firmare Upgrade Image}}; // MEMORYOBJECT1 | 
        
        try {
            MEMORY_OBJECT result = apiInstance.modifyDescMemoryObject(deviceId, cfgIdx, objIdx, mEMORYOBJECT1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MemoryObjectApi#modifyDescMemoryObject");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MemoryObjectApi;

public class MemoryObjectApiExample {
    public static void main(String[] args) {
        MemoryObjectApi apiInstance = new MemoryObjectApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer objIdx = 0; // Integer | Valid top level descriptor index

        MEMORYOBJECT1 mEMORYOBJECT1 = {MEMORY_OBJECT={objectName=Firmare Upgrade Image}}; // MEMORYOBJECT1 | 
        
        try {
            MEMORY_OBJECT result = apiInstance.modifyDescMemoryObject(deviceId, cfgIdx, objIdx, mEMORYOBJECT1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MemoryObjectApi#modifyDescMemoryObject");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MemoryObjectApi *apiInstance = [[MemoryObjectApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *objIdx = 0; // Valid top level descriptor index
 (default to null)
MEMORYOBJECT1 *mEMORYOBJECT1 = {MEMORY_OBJECT={objectName=Firmare Upgrade Image}}; //  (optional)

// modify Descriptor variable Values
[apiInstance modifyDescMemoryObjectWith:deviceId
    cfgIdx:cfgIdx
    objIdx:objIdx
    mEMORYOBJECT1:mEMORYOBJECT1
              completionHandler: ^(MEMORY_OBJECT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.MemoryObjectApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var objIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'mEMORYOBJECT1': {MEMORY_OBJECT={objectName=Firmare Upgrade Image}} // {MEMORYOBJECT1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyDescMemoryObject(deviceId, cfgIdx, objIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyDescMemoryObjectExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new MemoryObjectApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var objIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var mEMORYOBJECT1 = new MEMORYOBJECT1(); // MEMORYOBJECT1 |  (optional) 

            try {
                // modify Descriptor variable Values
                MEMORY_OBJECT result = apiInstance.modifyDescMemoryObject(deviceId, cfgIdx, objIdx, mEMORYOBJECT1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MemoryObjectApi.modifyDescMemoryObject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MemoryObjectApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$objIdx = 0; // Integer | Valid top level descriptor index

$mEMORYOBJECT1 = {MEMORY_OBJECT={objectName=Firmare Upgrade Image}}; // MEMORYOBJECT1 | 

try {
    $result = $api_instance->modifyDescMemoryObject($deviceId, $cfgIdx, $objIdx, $mEMORYOBJECT1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MemoryObjectApi->modifyDescMemoryObject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MemoryObjectApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MemoryObjectApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $objIdx = 0; # Integer | Valid top level descriptor index

my $mEMORYOBJECT1 = WWW::OPenAPIClient::Object::MEMORYOBJECT1->new(); # MEMORYOBJECT1 | 

eval { 
    my $result = $api_instance->modifyDescMemoryObject(deviceId => $deviceId, cfgIdx => $cfgIdx, objIdx => $objIdx, mEMORYOBJECT1 => $mEMORYOBJECT1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MemoryObjectApi->modifyDescMemoryObject: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.MemoryObjectApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
objIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
mEMORYOBJECT1 = {MEMORY_OBJECT={objectName=Firmare Upgrade Image}} # MEMORYOBJECT1 |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.modify_desc_memory_object(deviceId, cfgIdx, objIdx, mEMORYOBJECT1=mEMORYOBJECT1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MemoryObjectApi->modifyDescMemoryObject: %s\n" % e)
extern crate MemoryObjectApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let objIdx = 0; // Integer
    let mEMORYOBJECT1 = {MEMORY_OBJECT={objectName=Firmare Upgrade Image}}; // MEMORYOBJECT1

    let mut context = MemoryObjectApi::Context::default();
    let result = client.modifyDescMemoryObject(deviceId, cfgIdx, objIdx, mEMORYOBJECT1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
obj_idx*
Integer
Valid top level descriptor index
Required
Body parameters
Name Description
mEMORYOBJECT1

Set Object Name and Control Value

Responses


readMemoryObjectData

Get memoryObject data

The address access commands allows an Entity to expose register base device models ans allow for firmware updates. Entity must set in ADP discovery field entityCapabilities ADDRESS_ACCESS_SUPPORTED flag. The controller read the address parameter from Descriptor and set this automatecly. Optional can set address and length, the data may not be valid or the access may fail. The transmission used chunks, enters an error occurs, the connection is closed.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/memoryObject/{obj_idx}/data

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/memoryObject/{obj_idx}/data?address=&length="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MemoryObjectApi;

import java.io.File;
import java.util.*;

public class MemoryObjectApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        MemoryObjectApi apiInstance = new MemoryObjectApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer objIdx = 0; // Integer | Valid top level descriptor index

        String address = 0x655; // String | memory start adresses  

        Integer length = 1024; // Integer | memory data length

        
        try {
            inline_response_200_18 result = apiInstance.readMemoryObjectData(deviceId, cfgIdx, objIdx, address, length);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MemoryObjectApi#readMemoryObjectData");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MemoryObjectApi;

public class MemoryObjectApiExample {
    public static void main(String[] args) {
        MemoryObjectApi apiInstance = new MemoryObjectApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer objIdx = 0; // Integer | Valid top level descriptor index

        String address = 0x655; // String | memory start adresses  

        Integer length = 1024; // Integer | memory data length

        
        try {
            inline_response_200_18 result = apiInstance.readMemoryObjectData(deviceId, cfgIdx, objIdx, address, length);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MemoryObjectApi#readMemoryObjectData");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MemoryObjectApi *apiInstance = [[MemoryObjectApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *objIdx = 0; // Valid top level descriptor index
 (default to null)
String *address = 0x655; // memory start adresses  
 (optional) (default to null)
Integer *length = 1024; // memory data length
 (optional) (default to null)

// Get memoryObject data
[apiInstance readMemoryObjectDataWith:deviceId
    cfgIdx:cfgIdx
    objIdx:objIdx
    address:address
    length:length
              completionHandler: ^(inline_response_200_18 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.MemoryObjectApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var objIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'address': 0x655, // {String} memory start adresses  

  'length': 1024 // {Integer} memory data length

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readMemoryObjectData(deviceId, cfgIdx, objIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class readMemoryObjectDataExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new MemoryObjectApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var objIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var address = 0x655;  // String | memory start adresses  
 (optional)  (default to null)
            var length = 1024;  // Integer | memory data length
 (optional)  (default to null)

            try {
                // Get memoryObject data
                inline_response_200_18 result = apiInstance.readMemoryObjectData(deviceId, cfgIdx, objIdx, address, length);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MemoryObjectApi.readMemoryObjectData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MemoryObjectApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$objIdx = 0; // Integer | Valid top level descriptor index

$address = 0x655; // String | memory start adresses  

$length = 1024; // Integer | memory data length


try {
    $result = $api_instance->readMemoryObjectData($deviceId, $cfgIdx, $objIdx, $address, $length);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MemoryObjectApi->readMemoryObjectData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MemoryObjectApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MemoryObjectApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $objIdx = 0; # Integer | Valid top level descriptor index

my $address = 0x655; # String | memory start adresses  

my $length = 1024; # Integer | memory data length


eval { 
    my $result = $api_instance->readMemoryObjectData(deviceId => $deviceId, cfgIdx => $cfgIdx, objIdx => $objIdx, address => $address, length => $length);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MemoryObjectApi->readMemoryObjectData: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.MemoryObjectApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
objIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
address = 0x655 # String | memory start adresses  
 (optional) (default to null)
length = 1024 # Integer | memory data length
 (optional) (default to null)

try: 
    # Get memoryObject data
    api_response = api_instance.read_memory_object_data(deviceId, cfgIdx, objIdx, address=address, length=length)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MemoryObjectApi->readMemoryObjectData: %s\n" % e)
extern crate MemoryObjectApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let objIdx = 0; // Integer
    let address = 0x655; // String
    let length = 1024; // Integer

    let mut context = MemoryObjectApi::Context::default();
    let result = client.readMemoryObjectData(deviceId, cfgIdx, objIdx, address, length, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
obj_idx*
Integer
Valid top level descriptor index
Required
Query parameters
Name Description
address
String
memory start adresses
length
Integer
memory data length

Responses


rebootMemoryObject

Reboot Device from Descriptor MemoryObject

The **REBOOT** command is used to power cycle an Entity. If the Entity has MEMORY_OBJECT descriptors with a memory_object_type of FIRMWARE_IMAGE, then the REBOOT command may be used to select a firmware image to start after the reboot. In this case, the descriptor_type field is set to MEMORY_OBJECT and the descriptor_index is set to the index of the MEMORY_OBJECT to use.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/memoryObject/{obj_idx}/reboot

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/memoryObject/{obj_idx}/reboot"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MemoryObjectApi;

import java.io.File;
import java.util.*;

public class MemoryObjectApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        MemoryObjectApi apiInstance = new MemoryObjectApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer objIdx = 0; // Integer | Valid top level descriptor index

        Boolean boot = true; // Boolean | 
        
        try {
            inline_response_200_17 result = apiInstance.rebootMemoryObject(deviceId, cfgIdx, objIdx, boot);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MemoryObjectApi#rebootMemoryObject");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MemoryObjectApi;

public class MemoryObjectApiExample {
    public static void main(String[] args) {
        MemoryObjectApi apiInstance = new MemoryObjectApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer objIdx = 0; // Integer | Valid top level descriptor index

        Boolean boot = true; // Boolean | 
        
        try {
            inline_response_200_17 result = apiInstance.rebootMemoryObject(deviceId, cfgIdx, objIdx, boot);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MemoryObjectApi#rebootMemoryObject");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MemoryObjectApi *apiInstance = [[MemoryObjectApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *objIdx = 0; // Valid top level descriptor index
 (default to null)
Boolean *boot = true; //  (optional) (default to null)

// Reboot Device from Descriptor MemoryObject
[apiInstance rebootMemoryObjectWith:deviceId
    cfgIdx:cfgIdx
    objIdx:objIdx
    boot:boot
              completionHandler: ^(inline_response_200_17 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.MemoryObjectApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var objIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'boot': true // {Boolean} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.rebootMemoryObject(deviceId, cfgIdx, objIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class rebootMemoryObjectExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new MemoryObjectApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var objIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var boot = true;  // Boolean |  (optional)  (default to null)

            try {
                // Reboot Device from Descriptor MemoryObject
                inline_response_200_17 result = apiInstance.rebootMemoryObject(deviceId, cfgIdx, objIdx, boot);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MemoryObjectApi.rebootMemoryObject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MemoryObjectApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$objIdx = 0; // Integer | Valid top level descriptor index

$boot = true; // Boolean | 

try {
    $result = $api_instance->rebootMemoryObject($deviceId, $cfgIdx, $objIdx, $boot);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MemoryObjectApi->rebootMemoryObject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MemoryObjectApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MemoryObjectApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $objIdx = 0; # Integer | Valid top level descriptor index

my $boot = true; # Boolean | 

eval { 
    my $result = $api_instance->rebootMemoryObject(deviceId => $deviceId, cfgIdx => $cfgIdx, objIdx => $objIdx, boot => $boot);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MemoryObjectApi->rebootMemoryObject: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.MemoryObjectApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
objIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
boot = true # Boolean |  (optional) (default to null)

try: 
    # Reboot Device from Descriptor MemoryObject
    api_response = api_instance.reboot_memory_object(deviceId, cfgIdx, objIdx, boot=boot)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MemoryObjectApi->rebootMemoryObject: %s\n" % e)
extern crate MemoryObjectApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let objIdx = 0; // Integer
    let boot = true; // Boolean

    let mut context = MemoryObjectApi::Context::default();
    let result = client.rebootMemoryObject(deviceId, cfgIdx, objIdx, boot, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
obj_idx*
Integer
Valid top level descriptor index
Required
Form parameters
Name Description
boot
Boolean

Responses


writeDescMemoryObject

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Entity descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/memoryObject/{obj_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/memoryObject/{obj_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MemoryObjectApi;

import java.io.File;
import java.util.*;

public class MemoryObjectApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        MemoryObjectApi apiInstance = new MemoryObjectApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer objIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            MEMORY_OBJECT result = apiInstance.writeDescMemoryObject(deviceId, cfgIdx, objIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MemoryObjectApi#writeDescMemoryObject");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MemoryObjectApi;

public class MemoryObjectApiExample {
    public static void main(String[] args) {
        MemoryObjectApi apiInstance = new MemoryObjectApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer objIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            MEMORY_OBJECT result = apiInstance.writeDescMemoryObject(deviceId, cfgIdx, objIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MemoryObjectApi#writeDescMemoryObject");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MemoryObjectApi *apiInstance = [[MemoryObjectApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *objIdx = 0; // Valid top level descriptor index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance writeDescMemoryObjectWith:deviceId
    cfgIdx:cfgIdx
    objIdx:objIdx
    length:length
    data:data
              completionHandler: ^(MEMORY_OBJECT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.MemoryObjectApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var objIdx = 0; // {Integer} Valid top level descriptor index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescMemoryObject(deviceId, cfgIdx, objIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescMemoryObjectExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new MemoryObjectApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var objIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                MEMORY_OBJECT result = apiInstance.writeDescMemoryObject(deviceId, cfgIdx, objIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MemoryObjectApi.writeDescMemoryObject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MemoryObjectApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$objIdx = 0; // Integer | Valid top level descriptor index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescMemoryObject($deviceId, $cfgIdx, $objIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MemoryObjectApi->writeDescMemoryObject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MemoryObjectApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MemoryObjectApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $objIdx = 0; # Integer | Valid top level descriptor index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescMemoryObject(deviceId => $deviceId, cfgIdx => $cfgIdx, objIdx => $objIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MemoryObjectApi->writeDescMemoryObject: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.MemoryObjectApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
objIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.write_desc_memory_object(deviceId, cfgIdx, objIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MemoryObjectApi->writeDescMemoryObject: %s\n" % e)
extern crate MemoryObjectApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let objIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = MemoryObjectApi::Context::default();
    let result = client.writeDescMemoryObject(deviceId, cfgIdx, objIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
obj_idx*
Integer
Valid top level descriptor index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


writeMemoryObjectData

Write dat in memoryObject

The address access commands allows an Entity to expose register base device models ans allow for firmware updates. Entity must set in ADP discovery field entityCapabilities ADDRESS_ACCESS_SUPPORTED flag. The controller read the address parameter from Descriptor and set this automatecly. Optional can set address and length, the data may not be valid or the access may fail. The transmission used chunks, enters an error occurs, the connection is closed.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/memoryObject/{obj_idx}/data

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/memoryObject/{obj_idx}/data"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MemoryObjectApi;

import java.io.File;
import java.util.*;

public class MemoryObjectApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        MemoryObjectApi apiInstance = new MemoryObjectApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer objIdx = 0; // Integer | Valid top level descriptor index

        InlineObject57 inlineObject57 = ; // InlineObject57 | 
        
        try {
            inline_response_200_19 result = apiInstance.writeMemoryObjectData(deviceId, cfgIdx, objIdx, inlineObject57);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MemoryObjectApi#writeMemoryObjectData");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MemoryObjectApi;

public class MemoryObjectApiExample {
    public static void main(String[] args) {
        MemoryObjectApi apiInstance = new MemoryObjectApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer objIdx = 0; // Integer | Valid top level descriptor index

        InlineObject57 inlineObject57 = ; // InlineObject57 | 
        
        try {
            inline_response_200_19 result = apiInstance.writeMemoryObjectData(deviceId, cfgIdx, objIdx, inlineObject57);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MemoryObjectApi#writeMemoryObjectData");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MemoryObjectApi *apiInstance = [[MemoryObjectApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *objIdx = 0; // Valid top level descriptor index
 (default to null)
InlineObject57 *inlineObject57 = ; //  (optional)

// Write dat in memoryObject
[apiInstance writeMemoryObjectDataWith:deviceId
    cfgIdx:cfgIdx
    objIdx:objIdx
    inlineObject57:inlineObject57
              completionHandler: ^(inline_response_200_19 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.MemoryObjectApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var objIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'inlineObject57':  // {InlineObject57} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeMemoryObjectData(deviceId, cfgIdx, objIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeMemoryObjectDataExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new MemoryObjectApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var objIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var inlineObject57 = new InlineObject57(); // InlineObject57 |  (optional) 

            try {
                // Write dat in memoryObject
                inline_response_200_19 result = apiInstance.writeMemoryObjectData(deviceId, cfgIdx, objIdx, inlineObject57);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MemoryObjectApi.writeMemoryObjectData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MemoryObjectApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$objIdx = 0; // Integer | Valid top level descriptor index

$inlineObject57 = ; // InlineObject57 | 

try {
    $result = $api_instance->writeMemoryObjectData($deviceId, $cfgIdx, $objIdx, $inlineObject57);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MemoryObjectApi->writeMemoryObjectData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MemoryObjectApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MemoryObjectApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $objIdx = 0; # Integer | Valid top level descriptor index

my $inlineObject57 = WWW::OPenAPIClient::Object::InlineObject57->new(); # InlineObject57 | 

eval { 
    my $result = $api_instance->writeMemoryObjectData(deviceId => $deviceId, cfgIdx => $cfgIdx, objIdx => $objIdx, inlineObject57 => $inlineObject57);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MemoryObjectApi->writeMemoryObjectData: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.MemoryObjectApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
objIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
inlineObject57 =  # InlineObject57 |  (optional)

try: 
    # Write dat in memoryObject
    api_response = api_instance.write_memory_object_data(deviceId, cfgIdx, objIdx, inlineObject57=inlineObject57)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MemoryObjectApi->writeMemoryObjectData: %s\n" % e)
extern crate MemoryObjectApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let objIdx = 0; // Integer
    let inlineObject57 = ; // InlineObject57

    let mut context = MemoryObjectApi::Context::default();
    let result = client.writeMemoryObjectData(deviceId, cfgIdx, objIdx, inlineObject57, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
obj_idx*
Integer
Valid top level descriptor index
Required
Body parameters
Name Description
inlineObject57

Responses


Mixer

getDescMixer

Get mixer Descriptor


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/mixer/{mixer_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/mixer/{mixer_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MixerApi;

import java.io.File;
import java.util.*;

public class MixerApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        MixerApi apiInstance = new MixerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer mixerIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            MIXER result = apiInstance.getDescMixer(deviceId, cfgIdx, mixerIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MixerApi#getDescMixer");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MixerApi;

public class MixerApiExample {
    public static void main(String[] args) {
        MixerApi apiInstance = new MixerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer mixerIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            MIXER result = apiInstance.getDescMixer(deviceId, cfgIdx, mixerIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MixerApi#getDescMixer");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MixerApi *apiInstance = [[MixerApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *mixerIdx = 0; // Valid top level descriptor index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

// Get mixer Descriptor
[apiInstance getDescMixerWith:deviceId
    cfgIdx:cfgIdx
    mixerIdx:mixerIdx
    entity:entity
              completionHandler: ^(MIXER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.MixerApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var mixerIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescMixer(deviceId, cfgIdx, mixerIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescMixerExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new MixerApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var mixerIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional)  (default to null)

            try {
                // Get mixer Descriptor
                MIXER result = apiInstance.getDescMixer(deviceId, cfgIdx, mixerIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MixerApi.getDescMixer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MixerApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$mixerIdx = 0; // Integer | Valid top level descriptor index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


try {
    $result = $api_instance->getDescMixer($deviceId, $cfgIdx, $mixerIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MixerApi->getDescMixer: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MixerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MixerApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $mixerIdx = 0; # Integer | Valid top level descriptor index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


eval { 
    my $result = $api_instance->getDescMixer(deviceId => $deviceId, cfgIdx => $cfgIdx, mixerIdx => $mixerIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MixerApi->getDescMixer: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.MixerApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
mixerIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

try: 
    # Get mixer Descriptor
    api_response = api_instance.get_desc_mixer(deviceId, cfgIdx, mixerIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MixerApi->getDescMixer: %s\n" % e)
extern crate MixerApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let mixerIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = MixerApi::Context::default();
    let result = client.getDescMixer(deviceId, cfgIdx, mixerIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
mixer_idx*
Integer
Valid top level descriptor index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

Responses


modifyDescMixer

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command. *value* The **SET_MIXER** command acts on a MIXER descriptor in the current Configuration. An AVDECC Entity may propagate the Memory Object value change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. The mixer mixes control signals from different sources. All sources have the same controlValueType. The parameters depend on the controlValueType, please look in the extended documentation for which parameters can be set. Alternatively, you can specify the format yourself, but this can lead to incorrect values.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/mixer/{mixer_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/mixer/{mixer_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MixerApi;

import java.io.File;
import java.util.*;

public class MixerApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        MixerApi apiInstance = new MixerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer mixerIdx = 0; // Integer | Valid top level descriptor index

        MIXER1 mIXER1 = {MIXER={objectName=Mixer 0}}; // MIXER1 | 
        
        try {
            MIXER result = apiInstance.modifyDescMixer(deviceId, cfgIdx, mixerIdx, mIXER1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MixerApi#modifyDescMixer");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MixerApi;

public class MixerApiExample {
    public static void main(String[] args) {
        MixerApi apiInstance = new MixerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer mixerIdx = 0; // Integer | Valid top level descriptor index

        MIXER1 mIXER1 = {MIXER={objectName=Mixer 0}}; // MIXER1 | 
        
        try {
            MIXER result = apiInstance.modifyDescMixer(deviceId, cfgIdx, mixerIdx, mIXER1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MixerApi#modifyDescMixer");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MixerApi *apiInstance = [[MixerApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *mixerIdx = 0; // Valid top level descriptor index
 (default to null)
MIXER1 *mIXER1 = {MIXER={objectName=Mixer 0}}; //  (optional)

// modify Descriptor variable Values
[apiInstance modifyDescMixerWith:deviceId
    cfgIdx:cfgIdx
    mixerIdx:mixerIdx
    mIXER1:mIXER1
              completionHandler: ^(MIXER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.MixerApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var mixerIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'mIXER1': {MIXER={objectName=Mixer 0}} // {MIXER1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyDescMixer(deviceId, cfgIdx, mixerIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyDescMixerExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new MixerApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var mixerIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var mIXER1 = new MIXER1(); // MIXER1 |  (optional) 

            try {
                // modify Descriptor variable Values
                MIXER result = apiInstance.modifyDescMixer(deviceId, cfgIdx, mixerIdx, mIXER1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MixerApi.modifyDescMixer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MixerApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$mixerIdx = 0; // Integer | Valid top level descriptor index

$mIXER1 = {MIXER={objectName=Mixer 0}}; // MIXER1 | 

try {
    $result = $api_instance->modifyDescMixer($deviceId, $cfgIdx, $mixerIdx, $mIXER1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MixerApi->modifyDescMixer: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MixerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MixerApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $mixerIdx = 0; # Integer | Valid top level descriptor index

my $mIXER1 = WWW::OPenAPIClient::Object::MIXER1->new(); # MIXER1 | 

eval { 
    my $result = $api_instance->modifyDescMixer(deviceId => $deviceId, cfgIdx => $cfgIdx, mixerIdx => $mixerIdx, mIXER1 => $mIXER1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MixerApi->modifyDescMixer: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.MixerApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
mixerIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
mIXER1 = {MIXER={objectName=Mixer 0}} # MIXER1 |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.modify_desc_mixer(deviceId, cfgIdx, mixerIdx, mIXER1=mIXER1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MixerApi->modifyDescMixer: %s\n" % e)
extern crate MixerApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let mixerIdx = 0; // Integer
    let mIXER1 = {MIXER={objectName=Mixer 0}}; // MIXER1

    let mut context = MixerApi::Context::default();
    let result = client.modifyDescMixer(deviceId, cfgIdx, mixerIdx, mIXER1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
mixer_idx*
Integer
Valid top level descriptor index
Required
Body parameters
Name Description
mIXER1

Set Object Name and Control Value

Responses


writeDescMixer

Write Descriptor in device

The **WIRTE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/mixer/{mixer_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/mixer/{mixer_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MixerApi;

import java.io.File;
import java.util.*;

public class MixerApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        MixerApi apiInstance = new MixerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer mixerIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            MIXER result = apiInstance.writeDescMixer(deviceId, cfgIdx, mixerIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MixerApi#writeDescMixer");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MixerApi;

public class MixerApiExample {
    public static void main(String[] args) {
        MixerApi apiInstance = new MixerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer mixerIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            MIXER result = apiInstance.writeDescMixer(deviceId, cfgIdx, mixerIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MixerApi#writeDescMixer");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MixerApi *apiInstance = [[MixerApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *mixerIdx = 0; // Valid top level descriptor index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance writeDescMixerWith:deviceId
    cfgIdx:cfgIdx
    mixerIdx:mixerIdx
    length:length
    data:data
              completionHandler: ^(MIXER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.MixerApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var mixerIdx = 0; // {Integer} Valid top level descriptor index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescMixer(deviceId, cfgIdx, mixerIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescMixerExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new MixerApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var mixerIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                MIXER result = apiInstance.writeDescMixer(deviceId, cfgIdx, mixerIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MixerApi.writeDescMixer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MixerApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$mixerIdx = 0; // Integer | Valid top level descriptor index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescMixer($deviceId, $cfgIdx, $mixerIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MixerApi->writeDescMixer: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MixerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MixerApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $mixerIdx = 0; # Integer | Valid top level descriptor index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescMixer(deviceId => $deviceId, cfgIdx => $cfgIdx, mixerIdx => $mixerIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MixerApi->writeDescMixer: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.MixerApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
mixerIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.write_desc_mixer(deviceId, cfgIdx, mixerIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MixerApi->writeDescMixer: %s\n" % e)
extern crate MixerApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let mixerIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = MixerApi::Context::default();
    let result = client.writeDescMixer(deviceId, cfgIdx, mixerIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
mixer_idx*
Integer
Valid top level descriptor index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


Security

addAuthKey

Add Key to Entity

The **ADD_AUTH_KEY** command is used to add a key to an Entity. The add_authKey command may be protected by authentication. If this is the case, then the Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/security/authKey

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/authKey"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        InlineObject66 inlineObject66 = ; // InlineObject66 | 
        
        try {
            inline_response_200_11 result = apiInstance.addAuthKey(deviceId, inlineObject66);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#addAuthKey");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        InlineObject66 inlineObject66 = ; // InlineObject66 | 
        
        try {
            inline_response_200_11 result = apiInstance.addAuthKey(deviceId, inlineObject66);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#addAuthKey");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
InlineObject66 *inlineObject66 = ; // 

// Add Key to Entity
[apiInstance addAuthKeyWith:deviceId
    inlineObject66:inlineObject66
              completionHandler: ^(inline_response_200_11 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var inlineObject66 = ; // {InlineObject66} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addAuthKey(deviceId, inlineObject66, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class addAuthKeyExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var inlineObject66 = new InlineObject66(); // InlineObject66 | 

            try {
                // Add Key to Entity
                inline_response_200_11 result = apiInstance.addAuthKey(deviceId, inlineObject66);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.addAuthKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$inlineObject66 = ; // InlineObject66 | 

try {
    $result = $api_instance->addAuthKey($deviceId, $inlineObject66);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->addAuthKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $inlineObject66 = WWW::OPenAPIClient::Object::InlineObject66->new(); # InlineObject66 | 

eval { 
    my $result = $api_instance->addAuthKey(deviceId => $deviceId, inlineObject66 => $inlineObject66);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->addAuthKey: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
inlineObject66 =  # InlineObject66 | 

try: 
    # Add Key to Entity
    api_response = api_instance.add_auth_key(deviceId, inlineObject66)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->addAuthKey: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let inlineObject66 = ; // InlineObject66

    let mut context = SecurityApi::Context::default();
    let result = client.addAuthKey(deviceId, inlineObject66, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
Body parameters
Name Description
inlineObject66 *

Responses


addAuthToken

Add Token to device

The **ADD_TOKEN** command is used to set or replace the authentication token to be used by the AUTHENTICATE command. Adding an authentication token when one doesn’t exist triggers the Entity to require that the Controller authenticate to be able perform any action that is protected by authentication. When authentication is disabled, the AUTH_ADD_TOKEN command may be executed by any AVDECC Controller. If authentication has been enabled, however, the add_token command requires the Controller to be authenticated before the authentication token can be changed if the Controller is not authenticated, then the Entity responds with a NOT_AUTHENTICATED status response.


/v1.0/devices/{deviceId}/security/authToken

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/authToken"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        InlineObject65 inlineObject65 = ; // InlineObject65 | 
        
        try {
            inline_response_200_12 result = apiInstance.addAuthToken(deviceId, inlineObject65);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#addAuthToken");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        InlineObject65 inlineObject65 = ; // InlineObject65 | 
        
        try {
            inline_response_200_12 result = apiInstance.addAuthToken(deviceId, inlineObject65);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#addAuthToken");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
InlineObject65 *inlineObject65 = ; // 

// Add Token to device
[apiInstance addAuthTokenWith:deviceId
    inlineObject65:inlineObject65
              completionHandler: ^(inline_response_200_12 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var inlineObject65 = ; // {InlineObject65} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addAuthToken(deviceId, inlineObject65, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class addAuthTokenExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var inlineObject65 = new InlineObject65(); // InlineObject65 | 

            try {
                // Add Token to device
                inline_response_200_12 result = apiInstance.addAuthToken(deviceId, inlineObject65);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.addAuthToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$inlineObject65 = ; // InlineObject65 | 

try {
    $result = $api_instance->addAuthToken($deviceId, $inlineObject65);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->addAuthToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $inlineObject65 = WWW::OPenAPIClient::Object::InlineObject65->new(); # InlineObject65 | 

eval { 
    my $result = $api_instance->addAuthToken(deviceId => $deviceId, inlineObject65 => $inlineObject65);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->addAuthToken: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
inlineObject65 =  # InlineObject65 | 

try: 
    # Add Token to device
    api_response = api_instance.add_auth_token(deviceId, inlineObject65)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->addAuthToken: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let inlineObject65 = ; // InlineObject65

    let mut context = SecurityApi::Context::default();
    let result = client.addAuthToken(deviceId, inlineObject65, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
Body parameters
Name Description
inlineObject65 *

Responses


delAuthToken

Remove Token from device

The **REMOVE_TOKEN** command is used to remove the current authentication token and disable authentication. When authentication is disabled, the add_token command may be executed by any Controller. If authentication has been enabled, however, the add_token command requires the Controller to be authenticated before the authentication token can be changed if the Controller is not authenticated, then the Entity responds with a NOT_AUTHENTICATED status response.


/v1.0/devices/{deviceId}/security/authToken

Usage and SDK Samples

curl -X DELETE\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/authToken"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_12 result = apiInstance.delAuthToken(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#delAuthToken");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_12 result = apiInstance.delAuthToken(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#delAuthToken");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)

// Remove Token from device
[apiInstance delAuthTokenWith:deviceId
              completionHandler: ^(inline_response_200_12 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.delAuthToken(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class delAuthTokenExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)

            try {
                // Remove Token from device
                inline_response_200_12 result = apiInstance.delAuthToken(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.delAuthToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier


try {
    $result = $api_instance->delAuthToken($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->delAuthToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier


eval { 
    my $result = $api_instance->delAuthToken(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->delAuthToken: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)

try: 
    # Remove Token from device
    api_response = api_instance.del_auth_token(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->delAuthToken: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = SecurityApi::Context::default();
    let result = client.delAuthToken(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required

Responses


deleteAuthKey

Remove Key to Entity

The **REMOVE_AUTH_KEY** command is used to retrieve a key from a keychain. The remove_authKey command may be protected by authentication, If this is the case, then Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/security/authKey/{key_idx}

Usage and SDK Samples

curl -X DELETE\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/authKey/{key_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        String keyIdx = 12-12-33-44-55-67-77-66; // String | key identifier

        
        try {
            inline_response_200_12 result = apiInstance.deleteAuthKey(deviceId, keyIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#deleteAuthKey");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        String keyIdx = 12-12-33-44-55-67-77-66; // String | key identifier

        
        try {
            inline_response_200_12 result = apiInstance.deleteAuthKey(deviceId, keyIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#deleteAuthKey");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
String *keyIdx = 12-12-33-44-55-67-77-66; // key identifier
 (default to null)

// Remove Key to Entity
[apiInstance deleteAuthKeyWith:deviceId
    keyIdx:keyIdx
              completionHandler: ^(inline_response_200_12 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var keyIdx = 12-12-33-44-55-67-77-66; // {String} key identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteAuthKey(deviceId, keyIdx, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteAuthKeyExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var keyIdx = 12-12-33-44-55-67-77-66;  // String | key identifier
 (default to null)

            try {
                // Remove Key to Entity
                inline_response_200_12 result = apiInstance.deleteAuthKey(deviceId, keyIdx);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.deleteAuthKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$keyIdx = 12-12-33-44-55-67-77-66; // String | key identifier


try {
    $result = $api_instance->deleteAuthKey($deviceId, $keyIdx);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->deleteAuthKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $keyIdx = 12-12-33-44-55-67-77-66; # String | key identifier


eval { 
    my $result = $api_instance->deleteAuthKey(deviceId => $deviceId, keyIdx => $keyIdx);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->deleteAuthKey: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
keyIdx = 12-12-33-44-55-67-77-66 # String | key identifier
 (default to null)

try: 
    # Remove Key to Entity
    api_response = api_instance.delete_auth_key(deviceId, keyIdx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->deleteAuthKey: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let keyIdx = 12-12-33-44-55-67-77-66; // String

    let mut context = SecurityApi::Context::default();
    let result = client.deleteAuthKey(deviceId, keyIdx, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
key_idx*
String
key identifier
Required

Responses


deleteKeyFromChainManufakturerPublic

Remove key to chain

The **REMOVE_KEY_FROM_CHAIN** command is used to add a key to a key chain. The remove_keyFromKeychainlist command may be protected by authentication. If this is the case, then the Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/security/authKeychain/MANUFACTURER-PUBLIC

Usage and SDK Samples

curl -X DELETE\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/authKeychain/MANUFACTURER-PUBLIC"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_26 result = apiInstance.deleteKeyFromChainManufakturerPublic(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#deleteKeyFromChainManufakturerPublic");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_26 result = apiInstance.deleteKeyFromChainManufakturerPublic(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#deleteKeyFromChainManufakturerPublic");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)

// Remove key to chain
[apiInstance deleteKeyFromChainManufakturerPublicWith:deviceId
              completionHandler: ^(inline_response_200_26 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteKeyFromChainManufakturerPublic(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteKeyFromChainManufakturerPublicExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)

            try {
                // Remove key to chain
                inline_response_200_26 result = apiInstance.deleteKeyFromChainManufakturerPublic(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.deleteKeyFromChainManufakturerPublic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier


try {
    $result = $api_instance->deleteKeyFromChainManufakturerPublic($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->deleteKeyFromChainManufakturerPublic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier


eval { 
    my $result = $api_instance->deleteKeyFromChainManufakturerPublic(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->deleteKeyFromChainManufakturerPublic: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)

try: 
    # Remove key to chain
    api_response = api_instance.delete_key_from_chain_manufakturer_public(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->deleteKeyFromChainManufakturerPublic: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = SecurityApi::Context::default();
    let result = client.deleteKeyFromChainManufakturerPublic(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required

Responses


deleteKeyFromChainPrivate

Remove key to chain

The **REMOVE_KEY_FROM_CHAIN** command is used to add a key to a key chain. The remove_keyFromKeychainlist command may be protected by authentication. If this is the case, then the Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/security/authKeychain/ENTITY-PRIVATE

Usage and SDK Samples

curl -X DELETE\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/authKeychain/ENTITY-PRIVATE"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_26 result = apiInstance.deleteKeyFromChainPrivate(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#deleteKeyFromChainPrivate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_26 result = apiInstance.deleteKeyFromChainPrivate(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#deleteKeyFromChainPrivate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)

// Remove key to chain
[apiInstance deleteKeyFromChainPrivateWith:deviceId
              completionHandler: ^(inline_response_200_26 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteKeyFromChainPrivate(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteKeyFromChainPrivateExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)

            try {
                // Remove key to chain
                inline_response_200_26 result = apiInstance.deleteKeyFromChainPrivate(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.deleteKeyFromChainPrivate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier


try {
    $result = $api_instance->deleteKeyFromChainPrivate($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->deleteKeyFromChainPrivate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier


eval { 
    my $result = $api_instance->deleteKeyFromChainPrivate(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->deleteKeyFromChainPrivate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)

try: 
    # Remove key to chain
    api_response = api_instance.delete_key_from_chain_private(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->deleteKeyFromChainPrivate: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = SecurityApi::Context::default();
    let result = client.deleteKeyFromChainPrivate(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required

Responses


deleteKeyFromChainPublic

Remove key to chain

The **REMOVE_KEY_FROM_CHAIN** command is used to add a key to a key chain. The remove_keyFromKeychainlist command may be protected by authentication. If this is the case, then the Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/security/authKeychain/ENTITY-PUBLIC

Usage and SDK Samples

curl -X DELETE\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/authKeychain/ENTITY-PUBLIC"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_26 result = apiInstance.deleteKeyFromChainPublic(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#deleteKeyFromChainPublic");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_26 result = apiInstance.deleteKeyFromChainPublic(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#deleteKeyFromChainPublic");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)

// Remove key to chain
[apiInstance deleteKeyFromChainPublicWith:deviceId
              completionHandler: ^(inline_response_200_26 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteKeyFromChainPublic(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteKeyFromChainPublicExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)

            try {
                // Remove key to chain
                inline_response_200_26 result = apiInstance.deleteKeyFromChainPublic(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.deleteKeyFromChainPublic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier


try {
    $result = $api_instance->deleteKeyFromChainPublic($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->deleteKeyFromChainPublic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier


eval { 
    my $result = $api_instance->deleteKeyFromChainPublic(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->deleteKeyFromChainPublic: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)

try: 
    # Remove key to chain
    api_response = api_instance.delete_key_from_chain_public(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->deleteKeyFromChainPublic: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = SecurityApi::Context::default();
    let result = client.deleteKeyFromChainPublic(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required

Responses


deleteKeyFromChainPublicControllers

Remove key to chain

The **REMOVE_KEY_FROM_CHAIN** command is used to add a key to a key chain. The remove_keyFromKeychainlist command may be protected by authentication. If this is the case, then the Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/security/authKeychain/CONTROLLERS

Usage and SDK Samples

curl -X DELETE\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/authKeychain/CONTROLLERS"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_26 result = apiInstance.deleteKeyFromChainPublicControllers(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#deleteKeyFromChainPublicControllers");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_26 result = apiInstance.deleteKeyFromChainPublicControllers(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#deleteKeyFromChainPublicControllers");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)

// Remove key to chain
[apiInstance deleteKeyFromChainPublicControllersWith:deviceId
              completionHandler: ^(inline_response_200_26 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteKeyFromChainPublicControllers(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteKeyFromChainPublicControllersExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)

            try {
                // Remove key to chain
                inline_response_200_26 result = apiInstance.deleteKeyFromChainPublicControllers(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.deleteKeyFromChainPublicControllers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier


try {
    $result = $api_instance->deleteKeyFromChainPublicControllers($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->deleteKeyFromChainPublicControllers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier


eval { 
    my $result = $api_instance->deleteKeyFromChainPublicControllers(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->deleteKeyFromChainPublicControllers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)

try: 
    # Remove key to chain
    api_response = api_instance.delete_key_from_chain_public_controllers(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->deleteKeyFromChainPublicControllers: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = SecurityApi::Context::default();
    let result = client.deleteKeyFromChainPublicControllers(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required

Responses


deleteKeyFromChainPublicTransport

Remove key to chain

The **REMOVE_KEY_FROM_CHAIN** command is used to add a key to a key chain. The remove_keyFromKeychainlist command may be protected by authentication. If this is the case, then the Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/security/authKeychain/TRANSPORT

Usage and SDK Samples

curl -X DELETE\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/authKeychain/TRANSPORT"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_26 result = apiInstance.deleteKeyFromChainPublicTransport(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#deleteKeyFromChainPublicTransport");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_26 result = apiInstance.deleteKeyFromChainPublicTransport(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#deleteKeyFromChainPublicTransport");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)

// Remove key to chain
[apiInstance deleteKeyFromChainPublicTransportWith:deviceId
              completionHandler: ^(inline_response_200_26 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteKeyFromChainPublicTransport(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteKeyFromChainPublicTransportExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)

            try {
                // Remove key to chain
                inline_response_200_26 result = apiInstance.deleteKeyFromChainPublicTransport(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.deleteKeyFromChainPublicTransport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier


try {
    $result = $api_instance->deleteKeyFromChainPublicTransport($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->deleteKeyFromChainPublicTransport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier


eval { 
    my $result = $api_instance->deleteKeyFromChainPublicTransport(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->deleteKeyFromChainPublicTransport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)

try: 
    # Remove key to chain
    api_response = api_instance.delete_key_from_chain_public_transport(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->deleteKeyFromChainPublicTransport: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = SecurityApi::Context::default();
    let result = client.deleteKeyFromChainPublicTransport(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required

Responses


disableTransportSecurity

Disable Transport Security

The **DISABLE_TRANSPORT_SECURITY** command is used to switch the Entity to use insecure transport rather than secure transport of IEEE P1722.1 frames. The disable_transportSecurity command may be protected by authentication, If this is the case, then Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/security/transport

Usage and SDK Samples

curl -X DELETE\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/transport"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_12 result = apiInstance.disableTransportSecurity(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#disableTransportSecurity");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_12 result = apiInstance.disableTransportSecurity(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#disableTransportSecurity");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)

// Disable Transport Security
[apiInstance disableTransportSecurityWith:deviceId
              completionHandler: ^(inline_response_200_12 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.disableTransportSecurity(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class disableTransportSecurityExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)

            try {
                // Disable Transport Security
                inline_response_200_12 result = apiInstance.disableTransportSecurity(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.disableTransportSecurity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier


try {
    $result = $api_instance->disableTransportSecurity($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->disableTransportSecurity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier


eval { 
    my $result = $api_instance->disableTransportSecurity(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->disableTransportSecurity: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)

try: 
    # Disable Transport Security
    api_response = api_instance.disable_transport_security(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->disableTransportSecurity: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = SecurityApi::Context::default();
    let result = client.disableTransportSecurity(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required

Responses


enableTransportSecurity

Enable Transport Security

The **ENABLE_TRANSPORT_SECURITY** command is used to switch the Entity to use secure transport rather than insecure transport of IEEE P1722.1 frames. The enable_transportSecurity command may be protected by authentication, If this is the case, then Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/security/transport

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/transport"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        InlineObject67 inlineObject67 = ; // InlineObject67 | 
        
        try {
            inline_response_200_11 result = apiInstance.enableTransportSecurity(deviceId, inlineObject67);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#enableTransportSecurity");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        InlineObject67 inlineObject67 = ; // InlineObject67 | 
        
        try {
            inline_response_200_11 result = apiInstance.enableTransportSecurity(deviceId, inlineObject67);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#enableTransportSecurity");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
InlineObject67 *inlineObject67 = ; // 

// Enable Transport Security
[apiInstance enableTransportSecurityWith:deviceId
    inlineObject67:inlineObject67
              completionHandler: ^(inline_response_200_11 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var inlineObject67 = ; // {InlineObject67} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.enableTransportSecurity(deviceId, inlineObject67, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class enableTransportSecurityExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var inlineObject67 = new InlineObject67(); // InlineObject67 | 

            try {
                // Enable Transport Security
                inline_response_200_11 result = apiInstance.enableTransportSecurity(deviceId, inlineObject67);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.enableTransportSecurity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$inlineObject67 = ; // InlineObject67 | 

try {
    $result = $api_instance->enableTransportSecurity($deviceId, $inlineObject67);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->enableTransportSecurity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $inlineObject67 = WWW::OPenAPIClient::Object::InlineObject67->new(); # InlineObject67 | 

eval { 
    my $result = $api_instance->enableTransportSecurity(deviceId => $deviceId, inlineObject67 => $inlineObject67);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->enableTransportSecurity: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
inlineObject67 =  # InlineObject67 | 

try: 
    # Enable Transport Security
    api_response = api_instance.enable_transport_security(deviceId, inlineObject67)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->enableTransportSecurity: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let inlineObject67 = ; // InlineObject67

    let mut context = SecurityApi::Context::default();
    let result = client.enableTransportSecurity(deviceId, inlineObject67, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
Body parameters
Name Description
inlineObject67 *

Responses


getAuthIdentity

Get identity from device

The **GET_AUTH_IDENTITY** command is used to get the signature of the Entity as signed by the manufacturer to prove that the Entity is reporting its entity model correctly. The get_authIdentity command may be protected by authentication. If this is the case, then the Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/security/authIdentity

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/authIdentity"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_25 result = apiInstance.getAuthIdentity(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getAuthIdentity");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_25 result = apiInstance.getAuthIdentity(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getAuthIdentity");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)

// Get identity from device
[apiInstance getAuthIdentityWith:deviceId
              completionHandler: ^(inline_response_200_25 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAuthIdentity(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAuthIdentityExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)

            try {
                // Get identity from device
                inline_response_200_25 result = apiInstance.getAuthIdentity(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.getAuthIdentity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier


try {
    $result = $api_instance->getAuthIdentity($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->getAuthIdentity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier


eval { 
    my $result = $api_instance->getAuthIdentity(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->getAuthIdentity: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)

try: 
    # Get identity from device
    api_response = api_instance.get_auth_identity(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->getAuthIdentity: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = SecurityApi::Context::default();
    let result = client.getAuthIdentity(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required

Responses


getAuthKey

Get key from device

The **GET_AUTH_KEY** command is used to retrieve a key from an Entity. The get_authKey command may be protected by authentication, If this is the case, then Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated AVDECC Controller.


/v1.0/devices/{deviceId}/security/authKey/{key_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/authKey/{key_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        String keyIdx = 12-12-33-44-55-67-77-66; // String | key identifier

        
        try {
            inline_response_200_24 result = apiInstance.getAuthKey(deviceId, keyIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getAuthKey");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        String keyIdx = 12-12-33-44-55-67-77-66; // String | key identifier

        
        try {
            inline_response_200_24 result = apiInstance.getAuthKey(deviceId, keyIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getAuthKey");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
String *keyIdx = 12-12-33-44-55-67-77-66; // key identifier
 (default to null)

// Get key from device
[apiInstance getAuthKeyWith:deviceId
    keyIdx:keyIdx
              completionHandler: ^(inline_response_200_24 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var keyIdx = 12-12-33-44-55-67-77-66; // {String} key identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAuthKey(deviceId, keyIdx, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAuthKeyExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var keyIdx = 12-12-33-44-55-67-77-66;  // String | key identifier
 (default to null)

            try {
                // Get key from device
                inline_response_200_24 result = apiInstance.getAuthKey(deviceId, keyIdx);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.getAuthKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$keyIdx = 12-12-33-44-55-67-77-66; // String | key identifier


try {
    $result = $api_instance->getAuthKey($deviceId, $keyIdx);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->getAuthKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $keyIdx = 12-12-33-44-55-67-77-66; # String | key identifier


eval { 
    my $result = $api_instance->getAuthKey(deviceId => $deviceId, keyIdx => $keyIdx);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->getAuthKey: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
keyIdx = 12-12-33-44-55-67-77-66 # String | key identifier
 (default to null)

try: 
    # Get key from device
    api_response = api_instance.get_auth_key(deviceId, keyIdx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->getAuthKey: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let keyIdx = 12-12-33-44-55-67-77-66; // String

    let mut context = SecurityApi::Context::default();
    let result = client.getAuthKey(deviceId, keyIdx, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
key_idx*
String
key identifier
Required

Responses


getAuthKeyChainCntControllers

Get Keycount in List

The **GET_KEY_LIST_COUNT** command is used to get the count of key EUI-64s from the Entity. The get_keychainListCount command may be protected by authentication. If this is the case, then the Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/security/authKeychain/CONTROLLERS/count

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/authKeychain/CONTROLLERS/count"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_27 result = apiInstance.getAuthKeyChainCntControllers(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getAuthKeyChainCntControllers");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_27 result = apiInstance.getAuthKeyChainCntControllers(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getAuthKeyChainCntControllers");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)

// Get Keycount in List
[apiInstance getAuthKeyChainCntControllersWith:deviceId
              completionHandler: ^(inline_response_200_27 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAuthKeyChainCntControllers(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAuthKeyChainCntControllersExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)

            try {
                // Get Keycount in List
                inline_response_200_27 result = apiInstance.getAuthKeyChainCntControllers(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.getAuthKeyChainCntControllers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier


try {
    $result = $api_instance->getAuthKeyChainCntControllers($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->getAuthKeyChainCntControllers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier


eval { 
    my $result = $api_instance->getAuthKeyChainCntControllers(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->getAuthKeyChainCntControllers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)

try: 
    # Get Keycount in List
    api_response = api_instance.get_auth_key_chain_cnt_controllers(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->getAuthKeyChainCntControllers: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = SecurityApi::Context::default();
    let result = client.getAuthKeyChainCntControllers(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required

Responses


getAuthKeyChainCntManufakturerPublic

Get Keycount in List

The **GET_KEY_LIST_COUNT** command is used to get the count of key EUI-64s from the Entity. The get_keychainListCount command may be protected by authentication. If this is the case, then the Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/security/authKeychain/MANUFACTURER-PUBLIC/count

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/authKeychain/MANUFACTURER-PUBLIC/count"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_27 result = apiInstance.getAuthKeyChainCntManufakturerPublic(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getAuthKeyChainCntManufakturerPublic");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_27 result = apiInstance.getAuthKeyChainCntManufakturerPublic(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getAuthKeyChainCntManufakturerPublic");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)

// Get Keycount in List
[apiInstance getAuthKeyChainCntManufakturerPublicWith:deviceId
              completionHandler: ^(inline_response_200_27 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAuthKeyChainCntManufakturerPublic(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAuthKeyChainCntManufakturerPublicExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)

            try {
                // Get Keycount in List
                inline_response_200_27 result = apiInstance.getAuthKeyChainCntManufakturerPublic(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.getAuthKeyChainCntManufakturerPublic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier


try {
    $result = $api_instance->getAuthKeyChainCntManufakturerPublic($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->getAuthKeyChainCntManufakturerPublic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier


eval { 
    my $result = $api_instance->getAuthKeyChainCntManufakturerPublic(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->getAuthKeyChainCntManufakturerPublic: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)

try: 
    # Get Keycount in List
    api_response = api_instance.get_auth_key_chain_cnt_manufakturer_public(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->getAuthKeyChainCntManufakturerPublic: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = SecurityApi::Context::default();
    let result = client.getAuthKeyChainCntManufakturerPublic(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required

Responses


getAuthKeyChainCntPrivate

Get Keycount in List

The **GET_KEY_LIST_COUNT** command is used to get the count of key EUI-64s from the Entity. The get_keychainListCount command may be protected by authentication. If this is the case, then the Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/security/authKeychain/ENTITY-PRIVATE/count

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/authKeychain/ENTITY-PRIVATE/count"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_27 result = apiInstance.getAuthKeyChainCntPrivate(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getAuthKeyChainCntPrivate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_27 result = apiInstance.getAuthKeyChainCntPrivate(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getAuthKeyChainCntPrivate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)

// Get Keycount in List
[apiInstance getAuthKeyChainCntPrivateWith:deviceId
              completionHandler: ^(inline_response_200_27 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAuthKeyChainCntPrivate(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAuthKeyChainCntPrivateExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)

            try {
                // Get Keycount in List
                inline_response_200_27 result = apiInstance.getAuthKeyChainCntPrivate(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.getAuthKeyChainCntPrivate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier


try {
    $result = $api_instance->getAuthKeyChainCntPrivate($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->getAuthKeyChainCntPrivate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier


eval { 
    my $result = $api_instance->getAuthKeyChainCntPrivate(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->getAuthKeyChainCntPrivate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)

try: 
    # Get Keycount in List
    api_response = api_instance.get_auth_key_chain_cnt_private(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->getAuthKeyChainCntPrivate: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = SecurityApi::Context::default();
    let result = client.getAuthKeyChainCntPrivate(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required

Responses


getAuthKeyChainCntPublic

Get Keycount in List

The **GET_KEY_LIST_COUNT** command is used to get the count of key EUI-64s from the Entity. The get_keychainListCount command may be protected by authentication. If this is the case, then the Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/security/authKeychain/ENTITY-PUBLIC/count

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/authKeychain/ENTITY-PUBLIC/count"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_27 result = apiInstance.getAuthKeyChainCntPublic(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getAuthKeyChainCntPublic");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_27 result = apiInstance.getAuthKeyChainCntPublic(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getAuthKeyChainCntPublic");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)

// Get Keycount in List
[apiInstance getAuthKeyChainCntPublicWith:deviceId
              completionHandler: ^(inline_response_200_27 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAuthKeyChainCntPublic(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAuthKeyChainCntPublicExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)

            try {
                // Get Keycount in List
                inline_response_200_27 result = apiInstance.getAuthKeyChainCntPublic(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.getAuthKeyChainCntPublic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier


try {
    $result = $api_instance->getAuthKeyChainCntPublic($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->getAuthKeyChainCntPublic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier


eval { 
    my $result = $api_instance->getAuthKeyChainCntPublic(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->getAuthKeyChainCntPublic: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)

try: 
    # Get Keycount in List
    api_response = api_instance.get_auth_key_chain_cnt_public(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->getAuthKeyChainCntPublic: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = SecurityApi::Context::default();
    let result = client.getAuthKeyChainCntPublic(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required

Responses


getAuthKeyChainCntTransport

Get Keycount in List

The **GET_KEY_LIST_COUNT** command is used to get the count of key EUI-64s from the Entity. The get_keychainListCount command may be protected by authentication. If this is the case, then the Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/security/authKeychain/TRANSPORT/count

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/authKeychain/TRANSPORT/count"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_27 result = apiInstance.getAuthKeyChainCntTransport(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getAuthKeyChainCntTransport");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_27 result = apiInstance.getAuthKeyChainCntTransport(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getAuthKeyChainCntTransport");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)

// Get Keycount in List
[apiInstance getAuthKeyChainCntTransportWith:deviceId
              completionHandler: ^(inline_response_200_27 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAuthKeyChainCntTransport(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAuthKeyChainCntTransportExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)

            try {
                // Get Keycount in List
                inline_response_200_27 result = apiInstance.getAuthKeyChainCntTransport(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.getAuthKeyChainCntTransport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier


try {
    $result = $api_instance->getAuthKeyChainCntTransport($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->getAuthKeyChainCntTransport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier


eval { 
    my $result = $api_instance->getAuthKeyChainCntTransport(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->getAuthKeyChainCntTransport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)

try: 
    # Get Keycount in List
    api_response = api_instance.get_auth_key_chain_cnt_transport(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->getAuthKeyChainCntTransport: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = SecurityApi::Context::default();
    let result = client.getAuthKeyChainCntTransport(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required

Responses


getAuthKeysFromChainControllers

Get Keys in chain from device

The **GET_KEYCHAIN** command is used to get the list of key EUI-64s from the Entity. The get_keyChain command may be protected by authentication, If this is the case, then Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/security/authKeychain/CONTROLLERS/{idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/authKeychain/CONTROLLERS/{idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer idx = 0; // Integer | Keychain identfier

        
        try {
            inline_response_200_28 result = apiInstance.getAuthKeysFromChainControllers(deviceId, idx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getAuthKeysFromChainControllers");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer idx = 0; // Integer | Keychain identfier

        
        try {
            inline_response_200_28 result = apiInstance.getAuthKeysFromChainControllers(deviceId, idx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getAuthKeysFromChainControllers");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *idx = 0; // Keychain identfier
 (default to null)

// Get Keys in chain from device
[apiInstance getAuthKeysFromChainControllersWith:deviceId
    idx:idx
              completionHandler: ^(inline_response_200_28 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var idx = 0; // {Integer} Keychain identfier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAuthKeysFromChainControllers(deviceId, idx, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAuthKeysFromChainControllersExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var idx = 0;  // Integer | Keychain identfier
 (default to null)

            try {
                // Get Keys in chain from device
                inline_response_200_28 result = apiInstance.getAuthKeysFromChainControllers(deviceId, idx);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.getAuthKeysFromChainControllers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$idx = 0; // Integer | Keychain identfier


try {
    $result = $api_instance->getAuthKeysFromChainControllers($deviceId, $idx);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->getAuthKeysFromChainControllers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $idx = 0; # Integer | Keychain identfier


eval { 
    my $result = $api_instance->getAuthKeysFromChainControllers(deviceId => $deviceId, idx => $idx);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->getAuthKeysFromChainControllers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
idx = 0 # Integer | Keychain identfier
 (default to null)

try: 
    # Get Keys in chain from device
    api_response = api_instance.get_auth_keys_from_chain_controllers(deviceId, idx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->getAuthKeysFromChainControllers: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let idx = 0; // Integer

    let mut context = SecurityApi::Context::default();
    let result = client.getAuthKeysFromChainControllers(deviceId, idx, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
idx*
Integer
Keychain identfier
Required

Responses


getAuthKeysFromChainManufaturerPublic

Get Keys in chain from device

The **GET_KEYCHAIN** command is used to get the list of key EUI-64s from the Entity. The get_keyChain command may be protected by authentication, If this is the case, then Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/security/authKeychain/MANUFACTURER-PUBLIC/{idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/authKeychain/MANUFACTURER-PUBLIC/{idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer idx = 0; // Integer | Keychain identfier

        
        try {
            inline_response_200_28 result = apiInstance.getAuthKeysFromChainManufaturerPublic(deviceId, idx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getAuthKeysFromChainManufaturerPublic");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer idx = 0; // Integer | Keychain identfier

        
        try {
            inline_response_200_28 result = apiInstance.getAuthKeysFromChainManufaturerPublic(deviceId, idx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getAuthKeysFromChainManufaturerPublic");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *idx = 0; // Keychain identfier
 (default to null)

// Get Keys in chain from device
[apiInstance getAuthKeysFromChainManufaturerPublicWith:deviceId
    idx:idx
              completionHandler: ^(inline_response_200_28 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var idx = 0; // {Integer} Keychain identfier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAuthKeysFromChainManufaturerPublic(deviceId, idx, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAuthKeysFromChainManufaturerPublicExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var idx = 0;  // Integer | Keychain identfier
 (default to null)

            try {
                // Get Keys in chain from device
                inline_response_200_28 result = apiInstance.getAuthKeysFromChainManufaturerPublic(deviceId, idx);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.getAuthKeysFromChainManufaturerPublic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$idx = 0; // Integer | Keychain identfier


try {
    $result = $api_instance->getAuthKeysFromChainManufaturerPublic($deviceId, $idx);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->getAuthKeysFromChainManufaturerPublic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $idx = 0; # Integer | Keychain identfier


eval { 
    my $result = $api_instance->getAuthKeysFromChainManufaturerPublic(deviceId => $deviceId, idx => $idx);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->getAuthKeysFromChainManufaturerPublic: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
idx = 0 # Integer | Keychain identfier
 (default to null)

try: 
    # Get Keys in chain from device
    api_response = api_instance.get_auth_keys_from_chain_manufaturer_public(deviceId, idx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->getAuthKeysFromChainManufaturerPublic: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let idx = 0; // Integer

    let mut context = SecurityApi::Context::default();
    let result = client.getAuthKeysFromChainManufaturerPublic(deviceId, idx, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
idx*
Integer
Keychain identfier
Required

Responses


getAuthKeysFromChainPrivate

Get Keys in chain from device

The **GET_KEYCHAIN** command is used to get the list of key EUI-64s from the Entity. The get_keyChain command may be protected by authentication, If this is the case, then Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/security/authKeychain/ENTITY-PRIVATE/{idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/authKeychain/ENTITY-PRIVATE/{idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer idx = 0; // Integer | Keychain identfier

        
        try {
            inline_response_200_28 result = apiInstance.getAuthKeysFromChainPrivate(deviceId, idx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getAuthKeysFromChainPrivate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer idx = 0; // Integer | Keychain identfier

        
        try {
            inline_response_200_28 result = apiInstance.getAuthKeysFromChainPrivate(deviceId, idx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getAuthKeysFromChainPrivate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *idx = 0; // Keychain identfier
 (default to null)

// Get Keys in chain from device
[apiInstance getAuthKeysFromChainPrivateWith:deviceId
    idx:idx
              completionHandler: ^(inline_response_200_28 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var idx = 0; // {Integer} Keychain identfier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAuthKeysFromChainPrivate(deviceId, idx, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAuthKeysFromChainPrivateExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var idx = 0;  // Integer | Keychain identfier
 (default to null)

            try {
                // Get Keys in chain from device
                inline_response_200_28 result = apiInstance.getAuthKeysFromChainPrivate(deviceId, idx);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.getAuthKeysFromChainPrivate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$idx = 0; // Integer | Keychain identfier


try {
    $result = $api_instance->getAuthKeysFromChainPrivate($deviceId, $idx);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->getAuthKeysFromChainPrivate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $idx = 0; # Integer | Keychain identfier


eval { 
    my $result = $api_instance->getAuthKeysFromChainPrivate(deviceId => $deviceId, idx => $idx);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->getAuthKeysFromChainPrivate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
idx = 0 # Integer | Keychain identfier
 (default to null)

try: 
    # Get Keys in chain from device
    api_response = api_instance.get_auth_keys_from_chain_private(deviceId, idx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->getAuthKeysFromChainPrivate: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let idx = 0; // Integer

    let mut context = SecurityApi::Context::default();
    let result = client.getAuthKeysFromChainPrivate(deviceId, idx, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
idx*
Integer
Keychain identfier
Required

Responses


getAuthKeysFromChainPublic

Get Keys in chain from device

The **GET_KEYCHAIN** command is used to get the list of key EUI-64s from the Entity. The get_keyChain command may be protected by authentication, If this is the case, then Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/security/authKeychain/ENTITY-PUBLIC/{idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/authKeychain/ENTITY-PUBLIC/{idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer idx = 0; // Integer | Keychain identfier

        
        try {
            inline_response_200_28 result = apiInstance.getAuthKeysFromChainPublic(deviceId, idx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getAuthKeysFromChainPublic");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer idx = 0; // Integer | Keychain identfier

        
        try {
            inline_response_200_28 result = apiInstance.getAuthKeysFromChainPublic(deviceId, idx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getAuthKeysFromChainPublic");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *idx = 0; // Keychain identfier
 (default to null)

// Get Keys in chain from device
[apiInstance getAuthKeysFromChainPublicWith:deviceId
    idx:idx
              completionHandler: ^(inline_response_200_28 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var idx = 0; // {Integer} Keychain identfier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAuthKeysFromChainPublic(deviceId, idx, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAuthKeysFromChainPublicExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var idx = 0;  // Integer | Keychain identfier
 (default to null)

            try {
                // Get Keys in chain from device
                inline_response_200_28 result = apiInstance.getAuthKeysFromChainPublic(deviceId, idx);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.getAuthKeysFromChainPublic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$idx = 0; // Integer | Keychain identfier


try {
    $result = $api_instance->getAuthKeysFromChainPublic($deviceId, $idx);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->getAuthKeysFromChainPublic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $idx = 0; # Integer | Keychain identfier


eval { 
    my $result = $api_instance->getAuthKeysFromChainPublic(deviceId => $deviceId, idx => $idx);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->getAuthKeysFromChainPublic: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
idx = 0 # Integer | Keychain identfier
 (default to null)

try: 
    # Get Keys in chain from device
    api_response = api_instance.get_auth_keys_from_chain_public(deviceId, idx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->getAuthKeysFromChainPublic: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let idx = 0; // Integer

    let mut context = SecurityApi::Context::default();
    let result = client.getAuthKeysFromChainPublic(deviceId, idx, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
idx*
Integer
Keychain identfier
Required

Responses


getAuthKeysFromChainTransport

Get Keys in chain from device

The **GET_KEYCHAIN** command is used to get the list of key EUI-64s from the Entity. The get_keyChain command may be protected by authentication, If this is the case, then Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/security/authKeychain/TRANSPORT/{idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/authKeychain/TRANSPORT/{idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer idx = 0; // Integer | Keychain identfier

        
        try {
            inline_response_200_28 result = apiInstance.getAuthKeysFromChainTransport(deviceId, idx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getAuthKeysFromChainTransport");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer idx = 0; // Integer | Keychain identfier

        
        try {
            inline_response_200_28 result = apiInstance.getAuthKeysFromChainTransport(deviceId, idx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getAuthKeysFromChainTransport");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *idx = 0; // Keychain identfier
 (default to null)

// Get Keys in chain from device
[apiInstance getAuthKeysFromChainTransportWith:deviceId
    idx:idx
              completionHandler: ^(inline_response_200_28 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var idx = 0; // {Integer} Keychain identfier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAuthKeysFromChainTransport(deviceId, idx, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAuthKeysFromChainTransportExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var idx = 0;  // Integer | Keychain identfier
 (default to null)

            try {
                // Get Keys in chain from device
                inline_response_200_28 result = apiInstance.getAuthKeysFromChainTransport(deviceId, idx);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.getAuthKeysFromChainTransport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$idx = 0; // Integer | Keychain identfier


try {
    $result = $api_instance->getAuthKeysFromChainTransport($deviceId, $idx);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->getAuthKeysFromChainTransport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $idx = 0; # Integer | Keychain identfier


eval { 
    my $result = $api_instance->getAuthKeysFromChainTransport(deviceId => $deviceId, idx => $idx);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->getAuthKeysFromChainTransport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
idx = 0 # Integer | Keychain identfier
 (default to null)

try: 
    # Get Keys in chain from device
    api_response = api_instance.get_auth_keys_from_chain_transport(deviceId, idx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->getAuthKeysFromChainTransport: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let idx = 0; // Integer

    let mut context = SecurityApi::Context::default();
    let result = client.getAuthKeysFromChainTransport(deviceId, idx, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
idx*
Integer
Keychain identfier
Required

Responses


getSecurityEntry

Get Entity Security Status


/v1.0/devices/{deviceId}/security

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_23 result = apiInstance.getSecurityEntry(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getSecurityEntry");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_23 result = apiInstance.getSecurityEntry(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getSecurityEntry");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)

// Get Entity Security Status
[apiInstance getSecurityEntryWith:deviceId
              completionHandler: ^(inline_response_200_23 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSecurityEntry(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getSecurityEntryExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)

            try {
                // Get Entity Security Status
                inline_response_200_23 result = apiInstance.getSecurityEntry(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.getSecurityEntry: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier


try {
    $result = $api_instance->getSecurityEntry($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->getSecurityEntry: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier


eval { 
    my $result = $api_instance->getSecurityEntry(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->getSecurityEntry: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)

try: 
    # Get Entity Security Status
    api_response = api_instance.get_security_entry(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->getSecurityEntry: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = SecurityApi::Context::default();
    let result = client.getSecurityEntry(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required

Responses


postAuthKeyInChainControllers

Add key to chain

The **ADD_KEY_TO_CHAIN_LIST** command is used to add a key to a key chain. The add_keyToKeychainList command may be protected by authentication, If this is the case, then Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/security/authKeychain/CONTROLLERS

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/authKeychain/CONTROLLERS"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_26 result = apiInstance.postAuthKeyInChainControllers(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#postAuthKeyInChainControllers");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_26 result = apiInstance.postAuthKeyInChainControllers(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#postAuthKeyInChainControllers");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)

// Add key to chain
[apiInstance postAuthKeyInChainControllersWith:deviceId
              completionHandler: ^(inline_response_200_26 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postAuthKeyInChainControllers(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postAuthKeyInChainControllersExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)

            try {
                // Add key to chain
                inline_response_200_26 result = apiInstance.postAuthKeyInChainControllers(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.postAuthKeyInChainControllers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier


try {
    $result = $api_instance->postAuthKeyInChainControllers($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->postAuthKeyInChainControllers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier


eval { 
    my $result = $api_instance->postAuthKeyInChainControllers(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->postAuthKeyInChainControllers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)

try: 
    # Add key to chain
    api_response = api_instance.post_auth_key_in_chain_controllers(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->postAuthKeyInChainControllers: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = SecurityApi::Context::default();
    let result = client.postAuthKeyInChainControllers(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required

Responses


postAuthKeyInChainManufakturerPublic

Add key to chain

The **ADD_KEY_TO_CHAIN_LIST** command is used to add a key to a key chain. The add_keyToKeychainList command may be protected by authentication, If this is the case, then Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/security/authKeychain/MANUFACTURER-PUBLIC

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/authKeychain/MANUFACTURER-PUBLIC"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_26 result = apiInstance.postAuthKeyInChainManufakturerPublic(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#postAuthKeyInChainManufakturerPublic");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_26 result = apiInstance.postAuthKeyInChainManufakturerPublic(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#postAuthKeyInChainManufakturerPublic");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)

// Add key to chain
[apiInstance postAuthKeyInChainManufakturerPublicWith:deviceId
              completionHandler: ^(inline_response_200_26 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postAuthKeyInChainManufakturerPublic(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postAuthKeyInChainManufakturerPublicExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)

            try {
                // Add key to chain
                inline_response_200_26 result = apiInstance.postAuthKeyInChainManufakturerPublic(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.postAuthKeyInChainManufakturerPublic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier


try {
    $result = $api_instance->postAuthKeyInChainManufakturerPublic($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->postAuthKeyInChainManufakturerPublic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier


eval { 
    my $result = $api_instance->postAuthKeyInChainManufakturerPublic(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->postAuthKeyInChainManufakturerPublic: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)

try: 
    # Add key to chain
    api_response = api_instance.post_auth_key_in_chain_manufakturer_public(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->postAuthKeyInChainManufakturerPublic: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = SecurityApi::Context::default();
    let result = client.postAuthKeyInChainManufakturerPublic(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required

Responses


postAuthKeyInChainPrivate

Add key to chain

The **ADD_KEY_TO_CHAIN_LIST** command is used to add a key to a key chain. The add_keyToKeychainList command may be protected by authentication, If this is the case, then Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/security/authKeychain/ENTITY-PRIVATE

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/authKeychain/ENTITY-PRIVATE"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_26 result = apiInstance.postAuthKeyInChainPrivate(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#postAuthKeyInChainPrivate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_26 result = apiInstance.postAuthKeyInChainPrivate(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#postAuthKeyInChainPrivate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)

// Add key to chain
[apiInstance postAuthKeyInChainPrivateWith:deviceId
              completionHandler: ^(inline_response_200_26 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postAuthKeyInChainPrivate(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postAuthKeyInChainPrivateExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)

            try {
                // Add key to chain
                inline_response_200_26 result = apiInstance.postAuthKeyInChainPrivate(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.postAuthKeyInChainPrivate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier


try {
    $result = $api_instance->postAuthKeyInChainPrivate($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->postAuthKeyInChainPrivate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier


eval { 
    my $result = $api_instance->postAuthKeyInChainPrivate(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->postAuthKeyInChainPrivate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)

try: 
    # Add key to chain
    api_response = api_instance.post_auth_key_in_chain_private(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->postAuthKeyInChainPrivate: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = SecurityApi::Context::default();
    let result = client.postAuthKeyInChainPrivate(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required

Responses


postAuthKeyInChainPublic

Add key to chain

The **ADD_KEY_TO_CHAIN_LIST** command is used to add a key to a key chain. The add_keyToKeychainList command may be protected by authentication, If this is the case, then Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/security/authKeychain/ENTITY-PUBLIC

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/authKeychain/ENTITY-PUBLIC"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_26 result = apiInstance.postAuthKeyInChainPublic(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#postAuthKeyInChainPublic");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_26 result = apiInstance.postAuthKeyInChainPublic(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#postAuthKeyInChainPublic");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)

// Add key to chain
[apiInstance postAuthKeyInChainPublicWith:deviceId
              completionHandler: ^(inline_response_200_26 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postAuthKeyInChainPublic(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postAuthKeyInChainPublicExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)

            try {
                // Add key to chain
                inline_response_200_26 result = apiInstance.postAuthKeyInChainPublic(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.postAuthKeyInChainPublic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier


try {
    $result = $api_instance->postAuthKeyInChainPublic($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->postAuthKeyInChainPublic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier


eval { 
    my $result = $api_instance->postAuthKeyInChainPublic(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->postAuthKeyInChainPublic: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)

try: 
    # Add key to chain
    api_response = api_instance.post_auth_key_in_chain_public(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->postAuthKeyInChainPublic: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = SecurityApi::Context::default();
    let result = client.postAuthKeyInChainPublic(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required

Responses


postAuthKeyInChainTransport

Add key to chain

The **ADD_KEY_TO_CHAIN_LIST** command is used to add a key to a key chain. The add_keyToKeychainList command may be protected by authentication, If this is the case, then Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/security/authKeychain/TRANSPORT

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/security/authKeychain/TRANSPORT"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_26 result = apiInstance.postAuthKeyInChainTransport(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#postAuthKeyInChainTransport");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        
        try {
            inline_response_200_26 result = apiInstance.postAuthKeyInChainTransport(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#postAuthKeyInChainTransport");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)

// Add key to chain
[apiInstance postAuthKeyInChainTransportWith:deviceId
              completionHandler: ^(inline_response_200_26 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SecurityApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postAuthKeyInChainTransport(deviceId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postAuthKeyInChainTransportExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)

            try {
                // Add key to chain
                inline_response_200_26 result = apiInstance.postAuthKeyInChainTransport(deviceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.postAuthKeyInChainTransport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier


try {
    $result = $api_instance->postAuthKeyInChainTransport($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->postAuthKeyInChainTransport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier


eval { 
    my $result = $api_instance->postAuthKeyInChainTransport(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->postAuthKeyInChainTransport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)

try: 
    # Add key to chain
    api_response = api_instance.post_auth_key_in_chain_transport(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->postAuthKeyInChainTransport: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String

    let mut context = SecurityApi::Context::default();
    let result = client.postAuthKeyInChainTransport(deviceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required

Responses


SignalCombiner

getDescSignalCombiner

Get signalCombiner Descriptor


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalCombiner/{combiner_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalCombiner/{combiner_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SignalCombinerApi;

import java.io.File;
import java.util.*;

public class SignalCombinerApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SignalCombinerApi apiInstance = new SignalCombinerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer combinerIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            SIGNAL_COMBINER result = apiInstance.getDescSignalCombiner(deviceId, cfgIdx, combinerIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalCombinerApi#getDescSignalCombiner");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SignalCombinerApi;

public class SignalCombinerApiExample {
    public static void main(String[] args) {
        SignalCombinerApi apiInstance = new SignalCombinerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer combinerIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            SIGNAL_COMBINER result = apiInstance.getDescSignalCombiner(deviceId, cfgIdx, combinerIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalCombinerApi#getDescSignalCombiner");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SignalCombinerApi *apiInstance = [[SignalCombinerApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *combinerIdx = 0; // Valid top level descriptor index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

// Get signalCombiner Descriptor
[apiInstance getDescSignalCombinerWith:deviceId
    cfgIdx:cfgIdx
    combinerIdx:combinerIdx
    entity:entity
              completionHandler: ^(SIGNAL_COMBINER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SignalCombinerApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var combinerIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescSignalCombiner(deviceId, cfgIdx, combinerIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescSignalCombinerExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SignalCombinerApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var combinerIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional)  (default to null)

            try {
                // Get signalCombiner Descriptor
                SIGNAL_COMBINER result = apiInstance.getDescSignalCombiner(deviceId, cfgIdx, combinerIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SignalCombinerApi.getDescSignalCombiner: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SignalCombinerApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$combinerIdx = 0; // Integer | Valid top level descriptor index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


try {
    $result = $api_instance->getDescSignalCombiner($deviceId, $cfgIdx, $combinerIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SignalCombinerApi->getDescSignalCombiner: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SignalCombinerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SignalCombinerApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $combinerIdx = 0; # Integer | Valid top level descriptor index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


eval { 
    my $result = $api_instance->getDescSignalCombiner(deviceId => $deviceId, cfgIdx => $cfgIdx, combinerIdx => $combinerIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SignalCombinerApi->getDescSignalCombiner: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SignalCombinerApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
combinerIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

try: 
    # Get signalCombiner Descriptor
    api_response = api_instance.get_desc_signal_combiner(deviceId, cfgIdx, combinerIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SignalCombinerApi->getDescSignalCombiner: %s\n" % e)
extern crate SignalCombinerApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let combinerIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = SignalCombinerApi::Context::default();
    let result = client.getDescSignalCombiner(deviceId, cfgIdx, combinerIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
combiner_idx*
Integer
Valid top level descriptor index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

Responses


modifyDescSignalCombiner

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalCombiner/{combiner_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalCombiner/{combiner_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SignalCombinerApi;

import java.io.File;
import java.util.*;

public class SignalCombinerApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SignalCombinerApi apiInstance = new SignalCombinerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer combinerIdx = 0; // Integer | Valid top level descriptor index

        SIGNALCOMBINER1 sIGNALCOMBINER1 = {SIGNAL_COMBINER={objectName=Combiner 0}}; // SIGNALCOMBINER1 | 
        
        try {
            SIGNAL_COMBINER result = apiInstance.modifyDescSignalCombiner(deviceId, cfgIdx, combinerIdx, sIGNALCOMBINER1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalCombinerApi#modifyDescSignalCombiner");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SignalCombinerApi;

public class SignalCombinerApiExample {
    public static void main(String[] args) {
        SignalCombinerApi apiInstance = new SignalCombinerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer combinerIdx = 0; // Integer | Valid top level descriptor index

        SIGNALCOMBINER1 sIGNALCOMBINER1 = {SIGNAL_COMBINER={objectName=Combiner 0}}; // SIGNALCOMBINER1 | 
        
        try {
            SIGNAL_COMBINER result = apiInstance.modifyDescSignalCombiner(deviceId, cfgIdx, combinerIdx, sIGNALCOMBINER1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalCombinerApi#modifyDescSignalCombiner");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SignalCombinerApi *apiInstance = [[SignalCombinerApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *combinerIdx = 0; // Valid top level descriptor index
 (default to null)
SIGNALCOMBINER1 *sIGNALCOMBINER1 = {SIGNAL_COMBINER={objectName=Combiner 0}}; //  (optional)

// modify Descriptor variable Values
[apiInstance modifyDescSignalCombinerWith:deviceId
    cfgIdx:cfgIdx
    combinerIdx:combinerIdx
    sIGNALCOMBINER1:sIGNALCOMBINER1
              completionHandler: ^(SIGNAL_COMBINER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SignalCombinerApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var combinerIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'sIGNALCOMBINER1': {SIGNAL_COMBINER={objectName=Combiner 0}} // {SIGNALCOMBINER1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyDescSignalCombiner(deviceId, cfgIdx, combinerIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyDescSignalCombinerExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SignalCombinerApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var combinerIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var sIGNALCOMBINER1 = new SIGNALCOMBINER1(); // SIGNALCOMBINER1 |  (optional) 

            try {
                // modify Descriptor variable Values
                SIGNAL_COMBINER result = apiInstance.modifyDescSignalCombiner(deviceId, cfgIdx, combinerIdx, sIGNALCOMBINER1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SignalCombinerApi.modifyDescSignalCombiner: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SignalCombinerApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$combinerIdx = 0; // Integer | Valid top level descriptor index

$sIGNALCOMBINER1 = {SIGNAL_COMBINER={objectName=Combiner 0}}; // SIGNALCOMBINER1 | 

try {
    $result = $api_instance->modifyDescSignalCombiner($deviceId, $cfgIdx, $combinerIdx, $sIGNALCOMBINER1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SignalCombinerApi->modifyDescSignalCombiner: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SignalCombinerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SignalCombinerApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $combinerIdx = 0; # Integer | Valid top level descriptor index

my $sIGNALCOMBINER1 = WWW::OPenAPIClient::Object::SIGNALCOMBINER1->new(); # SIGNALCOMBINER1 | 

eval { 
    my $result = $api_instance->modifyDescSignalCombiner(deviceId => $deviceId, cfgIdx => $cfgIdx, combinerIdx => $combinerIdx, sIGNALCOMBINER1 => $sIGNALCOMBINER1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SignalCombinerApi->modifyDescSignalCombiner: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SignalCombinerApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
combinerIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
sIGNALCOMBINER1 = {SIGNAL_COMBINER={objectName=Combiner 0}} # SIGNALCOMBINER1 |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.modify_desc_signal_combiner(deviceId, cfgIdx, combinerIdx, sIGNALCOMBINER1=sIGNALCOMBINER1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SignalCombinerApi->modifyDescSignalCombiner: %s\n" % e)
extern crate SignalCombinerApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let combinerIdx = 0; // Integer
    let sIGNALCOMBINER1 = {SIGNAL_COMBINER={objectName=Combiner 0}}; // SIGNALCOMBINER1

    let mut context = SignalCombinerApi::Context::default();
    let result = client.modifyDescSignalCombiner(deviceId, cfgIdx, combinerIdx, sIGNALCOMBINER1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
combiner_idx*
Integer
Valid top level descriptor index
Required
Body parameters
Name Description
sIGNALCOMBINER1

Set Object Name

Responses


writeDescSignalCombiner

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalCombiner/{combiner_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalCombiner/{combiner_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SignalCombinerApi;

import java.io.File;
import java.util.*;

public class SignalCombinerApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SignalCombinerApi apiInstance = new SignalCombinerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer combinerIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            SIGNAL_COMBINER result = apiInstance.writeDescSignalCombiner(deviceId, cfgIdx, combinerIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalCombinerApi#writeDescSignalCombiner");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SignalCombinerApi;

public class SignalCombinerApiExample {
    public static void main(String[] args) {
        SignalCombinerApi apiInstance = new SignalCombinerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer combinerIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            SIGNAL_COMBINER result = apiInstance.writeDescSignalCombiner(deviceId, cfgIdx, combinerIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalCombinerApi#writeDescSignalCombiner");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SignalCombinerApi *apiInstance = [[SignalCombinerApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *combinerIdx = 0; // Valid top level descriptor index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance writeDescSignalCombinerWith:deviceId
    cfgIdx:cfgIdx
    combinerIdx:combinerIdx
    length:length
    data:data
              completionHandler: ^(SIGNAL_COMBINER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SignalCombinerApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var combinerIdx = 0; // {Integer} Valid top level descriptor index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescSignalCombiner(deviceId, cfgIdx, combinerIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescSignalCombinerExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SignalCombinerApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var combinerIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                SIGNAL_COMBINER result = apiInstance.writeDescSignalCombiner(deviceId, cfgIdx, combinerIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SignalCombinerApi.writeDescSignalCombiner: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SignalCombinerApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$combinerIdx = 0; // Integer | Valid top level descriptor index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescSignalCombiner($deviceId, $cfgIdx, $combinerIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SignalCombinerApi->writeDescSignalCombiner: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SignalCombinerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SignalCombinerApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $combinerIdx = 0; # Integer | Valid top level descriptor index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescSignalCombiner(deviceId => $deviceId, cfgIdx => $cfgIdx, combinerIdx => $combinerIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SignalCombinerApi->writeDescSignalCombiner: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SignalCombinerApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
combinerIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.write_desc_signal_combiner(deviceId, cfgIdx, combinerIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SignalCombinerApi->writeDescSignalCombiner: %s\n" % e)
extern crate SignalCombinerApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let combinerIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = SignalCombinerApi::Context::default();
    let result = client.writeDescSignalCombiner(deviceId, cfgIdx, combinerIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
combiner_idx*
Integer
Valid top level descriptor index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


SignalDemultiplexer

getDescSignalDemultiplexer

Get signalDemultiplexer Descriptor


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalDemultiplexer/{demultiplexer_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalDemultiplexer/{demultiplexer_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SignalDemultiplexerApi;

import java.io.File;
import java.util.*;

public class SignalDemultiplexerApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SignalDemultiplexerApi apiInstance = new SignalDemultiplexerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer demultiplexerIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            SIGNAL_DEMULTIPLEXER result = apiInstance.getDescSignalDemultiplexer(deviceId, cfgIdx, demultiplexerIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalDemultiplexerApi#getDescSignalDemultiplexer");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SignalDemultiplexerApi;

public class SignalDemultiplexerApiExample {
    public static void main(String[] args) {
        SignalDemultiplexerApi apiInstance = new SignalDemultiplexerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer demultiplexerIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            SIGNAL_DEMULTIPLEXER result = apiInstance.getDescSignalDemultiplexer(deviceId, cfgIdx, demultiplexerIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalDemultiplexerApi#getDescSignalDemultiplexer");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SignalDemultiplexerApi *apiInstance = [[SignalDemultiplexerApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *demultiplexerIdx = 0; // Valid top level descriptor index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

// Get signalDemultiplexer Descriptor
[apiInstance getDescSignalDemultiplexerWith:deviceId
    cfgIdx:cfgIdx
    demultiplexerIdx:demultiplexerIdx
    entity:entity
              completionHandler: ^(SIGNAL_DEMULTIPLEXER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SignalDemultiplexerApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var demultiplexerIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescSignalDemultiplexer(deviceId, cfgIdx, demultiplexerIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescSignalDemultiplexerExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SignalDemultiplexerApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var demultiplexerIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional)  (default to null)

            try {
                // Get signalDemultiplexer Descriptor
                SIGNAL_DEMULTIPLEXER result = apiInstance.getDescSignalDemultiplexer(deviceId, cfgIdx, demultiplexerIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SignalDemultiplexerApi.getDescSignalDemultiplexer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SignalDemultiplexerApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$demultiplexerIdx = 0; // Integer | Valid top level descriptor index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


try {
    $result = $api_instance->getDescSignalDemultiplexer($deviceId, $cfgIdx, $demultiplexerIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SignalDemultiplexerApi->getDescSignalDemultiplexer: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SignalDemultiplexerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SignalDemultiplexerApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $demultiplexerIdx = 0; # Integer | Valid top level descriptor index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


eval { 
    my $result = $api_instance->getDescSignalDemultiplexer(deviceId => $deviceId, cfgIdx => $cfgIdx, demultiplexerIdx => $demultiplexerIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SignalDemultiplexerApi->getDescSignalDemultiplexer: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SignalDemultiplexerApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
demultiplexerIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

try: 
    # Get signalDemultiplexer Descriptor
    api_response = api_instance.get_desc_signal_demultiplexer(deviceId, cfgIdx, demultiplexerIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SignalDemultiplexerApi->getDescSignalDemultiplexer: %s\n" % e)
extern crate SignalDemultiplexerApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let demultiplexerIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = SignalDemultiplexerApi::Context::default();
    let result = client.getDescSignalDemultiplexer(deviceId, cfgIdx, demultiplexerIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
demultiplexer_idx*
Integer
Valid top level descriptor index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

Responses


modifyDescSignalDemultiplexer

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalDemultiplexer/{demultiplexer_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalDemultiplexer/{demultiplexer_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SignalDemultiplexerApi;

import java.io.File;
import java.util.*;

public class SignalDemultiplexerApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SignalDemultiplexerApi apiInstance = new SignalDemultiplexerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer demultiplexerIdx = 0; // Integer | Valid top level descriptor index

        SIGNALDEMULTIPLEXER1 sIGNALDEMULTIPLEXER1 = {SIGNAL_DEMULTIPLEXER={objectName=Demultiplexer 0}}; // SIGNALDEMULTIPLEXER1 | 
        
        try {
            SIGNAL_DEMULTIPLEXER result = apiInstance.modifyDescSignalDemultiplexer(deviceId, cfgIdx, demultiplexerIdx, sIGNALDEMULTIPLEXER1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalDemultiplexerApi#modifyDescSignalDemultiplexer");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SignalDemultiplexerApi;

public class SignalDemultiplexerApiExample {
    public static void main(String[] args) {
        SignalDemultiplexerApi apiInstance = new SignalDemultiplexerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer demultiplexerIdx = 0; // Integer | Valid top level descriptor index

        SIGNALDEMULTIPLEXER1 sIGNALDEMULTIPLEXER1 = {SIGNAL_DEMULTIPLEXER={objectName=Demultiplexer 0}}; // SIGNALDEMULTIPLEXER1 | 
        
        try {
            SIGNAL_DEMULTIPLEXER result = apiInstance.modifyDescSignalDemultiplexer(deviceId, cfgIdx, demultiplexerIdx, sIGNALDEMULTIPLEXER1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalDemultiplexerApi#modifyDescSignalDemultiplexer");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SignalDemultiplexerApi *apiInstance = [[SignalDemultiplexerApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *demultiplexerIdx = 0; // Valid top level descriptor index
 (default to null)
SIGNALDEMULTIPLEXER1 *sIGNALDEMULTIPLEXER1 = {SIGNAL_DEMULTIPLEXER={objectName=Demultiplexer 0}}; //  (optional)

// modify Descriptor variable Values
[apiInstance modifyDescSignalDemultiplexerWith:deviceId
    cfgIdx:cfgIdx
    demultiplexerIdx:demultiplexerIdx
    sIGNALDEMULTIPLEXER1:sIGNALDEMULTIPLEXER1
              completionHandler: ^(SIGNAL_DEMULTIPLEXER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SignalDemultiplexerApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var demultiplexerIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'sIGNALDEMULTIPLEXER1': {SIGNAL_DEMULTIPLEXER={objectName=Demultiplexer 0}} // {SIGNALDEMULTIPLEXER1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyDescSignalDemultiplexer(deviceId, cfgIdx, demultiplexerIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyDescSignalDemultiplexerExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SignalDemultiplexerApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var demultiplexerIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var sIGNALDEMULTIPLEXER1 = new SIGNALDEMULTIPLEXER1(); // SIGNALDEMULTIPLEXER1 |  (optional) 

            try {
                // modify Descriptor variable Values
                SIGNAL_DEMULTIPLEXER result = apiInstance.modifyDescSignalDemultiplexer(deviceId, cfgIdx, demultiplexerIdx, sIGNALDEMULTIPLEXER1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SignalDemultiplexerApi.modifyDescSignalDemultiplexer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SignalDemultiplexerApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$demultiplexerIdx = 0; // Integer | Valid top level descriptor index

$sIGNALDEMULTIPLEXER1 = {SIGNAL_DEMULTIPLEXER={objectName=Demultiplexer 0}}; // SIGNALDEMULTIPLEXER1 | 

try {
    $result = $api_instance->modifyDescSignalDemultiplexer($deviceId, $cfgIdx, $demultiplexerIdx, $sIGNALDEMULTIPLEXER1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SignalDemultiplexerApi->modifyDescSignalDemultiplexer: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SignalDemultiplexerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SignalDemultiplexerApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $demultiplexerIdx = 0; # Integer | Valid top level descriptor index

my $sIGNALDEMULTIPLEXER1 = WWW::OPenAPIClient::Object::SIGNALDEMULTIPLEXER1->new(); # SIGNALDEMULTIPLEXER1 | 

eval { 
    my $result = $api_instance->modifyDescSignalDemultiplexer(deviceId => $deviceId, cfgIdx => $cfgIdx, demultiplexerIdx => $demultiplexerIdx, sIGNALDEMULTIPLEXER1 => $sIGNALDEMULTIPLEXER1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SignalDemultiplexerApi->modifyDescSignalDemultiplexer: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SignalDemultiplexerApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
demultiplexerIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
sIGNALDEMULTIPLEXER1 = {SIGNAL_DEMULTIPLEXER={objectName=Demultiplexer 0}} # SIGNALDEMULTIPLEXER1 |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.modify_desc_signal_demultiplexer(deviceId, cfgIdx, demultiplexerIdx, sIGNALDEMULTIPLEXER1=sIGNALDEMULTIPLEXER1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SignalDemultiplexerApi->modifyDescSignalDemultiplexer: %s\n" % e)
extern crate SignalDemultiplexerApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let demultiplexerIdx = 0; // Integer
    let sIGNALDEMULTIPLEXER1 = {SIGNAL_DEMULTIPLEXER={objectName=Demultiplexer 0}}; // SIGNALDEMULTIPLEXER1

    let mut context = SignalDemultiplexerApi::Context::default();
    let result = client.modifyDescSignalDemultiplexer(deviceId, cfgIdx, demultiplexerIdx, sIGNALDEMULTIPLEXER1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
demultiplexer_idx*
Integer
Valid top level descriptor index
Required
Body parameters
Name Description
sIGNALDEMULTIPLEXER1

Set Object Name

Responses


writeDescSignalDemultiplexer

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalDemultiplexer/{demultiplexer_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalDemultiplexer/{demultiplexer_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SignalDemultiplexerApi;

import java.io.File;
import java.util.*;

public class SignalDemultiplexerApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SignalDemultiplexerApi apiInstance = new SignalDemultiplexerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer demultiplexerIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            SIGNAL_DEMULTIPLEXER result = apiInstance.writeDescSignalDemultiplexer(deviceId, cfgIdx, demultiplexerIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalDemultiplexerApi#writeDescSignalDemultiplexer");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SignalDemultiplexerApi;

public class SignalDemultiplexerApiExample {
    public static void main(String[] args) {
        SignalDemultiplexerApi apiInstance = new SignalDemultiplexerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer demultiplexerIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            SIGNAL_DEMULTIPLEXER result = apiInstance.writeDescSignalDemultiplexer(deviceId, cfgIdx, demultiplexerIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalDemultiplexerApi#writeDescSignalDemultiplexer");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SignalDemultiplexerApi *apiInstance = [[SignalDemultiplexerApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *demultiplexerIdx = 0; // Valid top level descriptor index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance writeDescSignalDemultiplexerWith:deviceId
    cfgIdx:cfgIdx
    demultiplexerIdx:demultiplexerIdx
    length:length
    data:data
              completionHandler: ^(SIGNAL_DEMULTIPLEXER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SignalDemultiplexerApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var demultiplexerIdx = 0; // {Integer} Valid top level descriptor index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescSignalDemultiplexer(deviceId, cfgIdx, demultiplexerIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescSignalDemultiplexerExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SignalDemultiplexerApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var demultiplexerIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                SIGNAL_DEMULTIPLEXER result = apiInstance.writeDescSignalDemultiplexer(deviceId, cfgIdx, demultiplexerIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SignalDemultiplexerApi.writeDescSignalDemultiplexer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SignalDemultiplexerApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$demultiplexerIdx = 0; // Integer | Valid top level descriptor index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescSignalDemultiplexer($deviceId, $cfgIdx, $demultiplexerIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SignalDemultiplexerApi->writeDescSignalDemultiplexer: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SignalDemultiplexerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SignalDemultiplexerApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $demultiplexerIdx = 0; # Integer | Valid top level descriptor index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescSignalDemultiplexer(deviceId => $deviceId, cfgIdx => $cfgIdx, demultiplexerIdx => $demultiplexerIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SignalDemultiplexerApi->writeDescSignalDemultiplexer: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SignalDemultiplexerApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
demultiplexerIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.write_desc_signal_demultiplexer(deviceId, cfgIdx, demultiplexerIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SignalDemultiplexerApi->writeDescSignalDemultiplexer: %s\n" % e)
extern crate SignalDemultiplexerApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let demultiplexerIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = SignalDemultiplexerApi::Context::default();
    let result = client.writeDescSignalDemultiplexer(deviceId, cfgIdx, demultiplexerIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
demultiplexer_idx*
Integer
Valid top level descriptor index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


SignalMultiplexer

getDescSignalMultiplexer

Get signalMultiplexer Descriptor


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalMultiplexer/{multiplexer_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalMultiplexer/{multiplexer_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SignalMultiplexerApi;

import java.io.File;
import java.util.*;

public class SignalMultiplexerApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SignalMultiplexerApi apiInstance = new SignalMultiplexerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer multiplexerIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            SIGNAL_MULTIPLEXER result = apiInstance.getDescSignalMultiplexer(deviceId, cfgIdx, multiplexerIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalMultiplexerApi#getDescSignalMultiplexer");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SignalMultiplexerApi;

public class SignalMultiplexerApiExample {
    public static void main(String[] args) {
        SignalMultiplexerApi apiInstance = new SignalMultiplexerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer multiplexerIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            SIGNAL_MULTIPLEXER result = apiInstance.getDescSignalMultiplexer(deviceId, cfgIdx, multiplexerIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalMultiplexerApi#getDescSignalMultiplexer");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SignalMultiplexerApi *apiInstance = [[SignalMultiplexerApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *multiplexerIdx = 0; // Valid top level descriptor index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

// Get signalMultiplexer Descriptor
[apiInstance getDescSignalMultiplexerWith:deviceId
    cfgIdx:cfgIdx
    multiplexerIdx:multiplexerIdx
    entity:entity
              completionHandler: ^(SIGNAL_MULTIPLEXER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SignalMultiplexerApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var multiplexerIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescSignalMultiplexer(deviceId, cfgIdx, multiplexerIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescSignalMultiplexerExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SignalMultiplexerApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var multiplexerIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional)  (default to null)

            try {
                // Get signalMultiplexer Descriptor
                SIGNAL_MULTIPLEXER result = apiInstance.getDescSignalMultiplexer(deviceId, cfgIdx, multiplexerIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SignalMultiplexerApi.getDescSignalMultiplexer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SignalMultiplexerApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$multiplexerIdx = 0; // Integer | Valid top level descriptor index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


try {
    $result = $api_instance->getDescSignalMultiplexer($deviceId, $cfgIdx, $multiplexerIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SignalMultiplexerApi->getDescSignalMultiplexer: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SignalMultiplexerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SignalMultiplexerApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $multiplexerIdx = 0; # Integer | Valid top level descriptor index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


eval { 
    my $result = $api_instance->getDescSignalMultiplexer(deviceId => $deviceId, cfgIdx => $cfgIdx, multiplexerIdx => $multiplexerIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SignalMultiplexerApi->getDescSignalMultiplexer: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SignalMultiplexerApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
multiplexerIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

try: 
    # Get signalMultiplexer Descriptor
    api_response = api_instance.get_desc_signal_multiplexer(deviceId, cfgIdx, multiplexerIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SignalMultiplexerApi->getDescSignalMultiplexer: %s\n" % e)
extern crate SignalMultiplexerApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let multiplexerIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = SignalMultiplexerApi::Context::default();
    let result = client.getDescSignalMultiplexer(deviceId, cfgIdx, multiplexerIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
multiplexer_idx*
Integer
Valid top level descriptor index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

Responses


modifyDescSignalMultiplexer

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalMultiplexer/{multiplexer_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalMultiplexer/{multiplexer_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SignalMultiplexerApi;

import java.io.File;
import java.util.*;

public class SignalMultiplexerApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SignalMultiplexerApi apiInstance = new SignalMultiplexerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer multiplexerIdx = 0; // Integer | Valid top level descriptor index

        SIGNALMULTIPLEXER sIGNALMULTIPLEXER = {SIGNAL_MULTIPLEXER={objectName=Multiplexer 0}}; // SIGNALMULTIPLEXER | 
        
        try {
            SIGNAL_MULTIPLEXER result = apiInstance.modifyDescSignalMultiplexer(deviceId, cfgIdx, multiplexerIdx, sIGNALMULTIPLEXER);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalMultiplexerApi#modifyDescSignalMultiplexer");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SignalMultiplexerApi;

public class SignalMultiplexerApiExample {
    public static void main(String[] args) {
        SignalMultiplexerApi apiInstance = new SignalMultiplexerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer multiplexerIdx = 0; // Integer | Valid top level descriptor index

        SIGNALMULTIPLEXER sIGNALMULTIPLEXER = {SIGNAL_MULTIPLEXER={objectName=Multiplexer 0}}; // SIGNALMULTIPLEXER | 
        
        try {
            SIGNAL_MULTIPLEXER result = apiInstance.modifyDescSignalMultiplexer(deviceId, cfgIdx, multiplexerIdx, sIGNALMULTIPLEXER);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalMultiplexerApi#modifyDescSignalMultiplexer");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SignalMultiplexerApi *apiInstance = [[SignalMultiplexerApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *multiplexerIdx = 0; // Valid top level descriptor index
 (default to null)
SIGNALMULTIPLEXER *sIGNALMULTIPLEXER = {SIGNAL_MULTIPLEXER={objectName=Multiplexer 0}}; //  (optional)

// modify Descriptor variable Values
[apiInstance modifyDescSignalMultiplexerWith:deviceId
    cfgIdx:cfgIdx
    multiplexerIdx:multiplexerIdx
    sIGNALMULTIPLEXER:sIGNALMULTIPLEXER
              completionHandler: ^(SIGNAL_MULTIPLEXER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SignalMultiplexerApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var multiplexerIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'sIGNALMULTIPLEXER': {SIGNAL_MULTIPLEXER={objectName=Multiplexer 0}} // {SIGNALMULTIPLEXER} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyDescSignalMultiplexer(deviceId, cfgIdx, multiplexerIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyDescSignalMultiplexerExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SignalMultiplexerApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var multiplexerIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var sIGNALMULTIPLEXER = new SIGNALMULTIPLEXER(); // SIGNALMULTIPLEXER |  (optional) 

            try {
                // modify Descriptor variable Values
                SIGNAL_MULTIPLEXER result = apiInstance.modifyDescSignalMultiplexer(deviceId, cfgIdx, multiplexerIdx, sIGNALMULTIPLEXER);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SignalMultiplexerApi.modifyDescSignalMultiplexer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SignalMultiplexerApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$multiplexerIdx = 0; // Integer | Valid top level descriptor index

$sIGNALMULTIPLEXER = {SIGNAL_MULTIPLEXER={objectName=Multiplexer 0}}; // SIGNALMULTIPLEXER | 

try {
    $result = $api_instance->modifyDescSignalMultiplexer($deviceId, $cfgIdx, $multiplexerIdx, $sIGNALMULTIPLEXER);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SignalMultiplexerApi->modifyDescSignalMultiplexer: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SignalMultiplexerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SignalMultiplexerApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $multiplexerIdx = 0; # Integer | Valid top level descriptor index

my $sIGNALMULTIPLEXER = WWW::OPenAPIClient::Object::SIGNALMULTIPLEXER->new(); # SIGNALMULTIPLEXER | 

eval { 
    my $result = $api_instance->modifyDescSignalMultiplexer(deviceId => $deviceId, cfgIdx => $cfgIdx, multiplexerIdx => $multiplexerIdx, sIGNALMULTIPLEXER => $sIGNALMULTIPLEXER);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SignalMultiplexerApi->modifyDescSignalMultiplexer: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SignalMultiplexerApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
multiplexerIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
sIGNALMULTIPLEXER = {SIGNAL_MULTIPLEXER={objectName=Multiplexer 0}} # SIGNALMULTIPLEXER |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.modify_desc_signal_multiplexer(deviceId, cfgIdx, multiplexerIdx, sIGNALMULTIPLEXER=sIGNALMULTIPLEXER)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SignalMultiplexerApi->modifyDescSignalMultiplexer: %s\n" % e)
extern crate SignalMultiplexerApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let multiplexerIdx = 0; // Integer
    let sIGNALMULTIPLEXER = {SIGNAL_MULTIPLEXER={objectName=Multiplexer 0}}; // SIGNALMULTIPLEXER

    let mut context = SignalMultiplexerApi::Context::default();
    let result = client.modifyDescSignalMultiplexer(deviceId, cfgIdx, multiplexerIdx, sIGNALMULTIPLEXER, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
multiplexer_idx*
Integer
Valid top level descriptor index
Required
Body parameters
Name Description
sIGNALMULTIPLEXER

Set Object Name

Responses


writeDescSignalMultiplexer

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalMultiplexer/{multiplexer_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalMultiplexer/{multiplexer_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SignalMultiplexerApi;

import java.io.File;
import java.util.*;

public class SignalMultiplexerApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SignalMultiplexerApi apiInstance = new SignalMultiplexerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer multiplexerIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            SIGNAL_MULTIPLEXER result = apiInstance.writeDescSignalMultiplexer(deviceId, cfgIdx, multiplexerIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalMultiplexerApi#writeDescSignalMultiplexer");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SignalMultiplexerApi;

public class SignalMultiplexerApiExample {
    public static void main(String[] args) {
        SignalMultiplexerApi apiInstance = new SignalMultiplexerApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer multiplexerIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            SIGNAL_MULTIPLEXER result = apiInstance.writeDescSignalMultiplexer(deviceId, cfgIdx, multiplexerIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalMultiplexerApi#writeDescSignalMultiplexer");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SignalMultiplexerApi *apiInstance = [[SignalMultiplexerApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *multiplexerIdx = 0; // Valid top level descriptor index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance writeDescSignalMultiplexerWith:deviceId
    cfgIdx:cfgIdx
    multiplexerIdx:multiplexerIdx
    length:length
    data:data
              completionHandler: ^(SIGNAL_MULTIPLEXER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SignalMultiplexerApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var multiplexerIdx = 0; // {Integer} Valid top level descriptor index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescSignalMultiplexer(deviceId, cfgIdx, multiplexerIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescSignalMultiplexerExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SignalMultiplexerApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var multiplexerIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                SIGNAL_MULTIPLEXER result = apiInstance.writeDescSignalMultiplexer(deviceId, cfgIdx, multiplexerIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SignalMultiplexerApi.writeDescSignalMultiplexer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SignalMultiplexerApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$multiplexerIdx = 0; // Integer | Valid top level descriptor index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescSignalMultiplexer($deviceId, $cfgIdx, $multiplexerIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SignalMultiplexerApi->writeDescSignalMultiplexer: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SignalMultiplexerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SignalMultiplexerApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $multiplexerIdx = 0; # Integer | Valid top level descriptor index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescSignalMultiplexer(deviceId => $deviceId, cfgIdx => $cfgIdx, multiplexerIdx => $multiplexerIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SignalMultiplexerApi->writeDescSignalMultiplexer: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SignalMultiplexerApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
multiplexerIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.write_desc_signal_multiplexer(deviceId, cfgIdx, multiplexerIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SignalMultiplexerApi->writeDescSignalMultiplexer: %s\n" % e)
extern crate SignalMultiplexerApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let multiplexerIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = SignalMultiplexerApi::Context::default();
    let result = client.writeDescSignalMultiplexer(deviceId, cfgIdx, multiplexerIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
multiplexer_idx*
Integer
Valid top level descriptor index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


SignalSelector

getDescSignalSelector

Get control Descriptor


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalSelector/{selector_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalSelector/{selector_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SignalSelectorApi;

import java.io.File;
import java.util.*;

public class SignalSelectorApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SignalSelectorApi apiInstance = new SignalSelectorApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer selectorIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*currentSignal* The **GET_SIGNAL_SELECTOR** command is used to get the current source of a Signal Selector Control. 
The get_signal_selector command returns the source of a Signal Selector for the currently active Configuration.

        
        try {
            SIGNAL_SELECTOR result = apiInstance.getDescSignalSelector(deviceId, cfgIdx, selectorIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalSelectorApi#getDescSignalSelector");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SignalSelectorApi;

public class SignalSelectorApiExample {
    public static void main(String[] args) {
        SignalSelectorApi apiInstance = new SignalSelectorApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer selectorIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*currentSignal* The **GET_SIGNAL_SELECTOR** command is used to get the current source of a Signal Selector Control. 
The get_signal_selector command returns the source of a Signal Selector for the currently active Configuration.

        
        try {
            SIGNAL_SELECTOR result = apiInstance.getDescSignalSelector(deviceId, cfgIdx, selectorIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalSelectorApi#getDescSignalSelector");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SignalSelectorApi *apiInstance = [[SignalSelectorApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *selectorIdx = 0; // Valid top level descriptor index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*currentSignal* The **GET_SIGNAL_SELECTOR** command is used to get the current source of a Signal Selector Control. 
The get_signal_selector command returns the source of a Signal Selector for the currently active Configuration.
 (optional) (default to null)

// Get control Descriptor
[apiInstance getDescSignalSelectorWith:deviceId
    cfgIdx:cfgIdx
    selectorIdx:selectorIdx
    entity:entity
              completionHandler: ^(SIGNAL_SELECTOR output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SignalSelectorApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var selectorIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*currentSignal* The **GET_SIGNAL_SELECTOR** command is used to get the current source of a Signal Selector Control. 
The get_signal_selector command returns the source of a Signal Selector for the currently active Configuration.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescSignalSelector(deviceId, cfgIdx, selectorIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescSignalSelectorExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SignalSelectorApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var selectorIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*currentSignal* The **GET_SIGNAL_SELECTOR** command is used to get the current source of a Signal Selector Control. 
The get_signal_selector command returns the source of a Signal Selector for the currently active Configuration.
 (optional)  (default to null)

            try {
                // Get control Descriptor
                SIGNAL_SELECTOR result = apiInstance.getDescSignalSelector(deviceId, cfgIdx, selectorIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SignalSelectorApi.getDescSignalSelector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SignalSelectorApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$selectorIdx = 0; // Integer | Valid top level descriptor index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*currentSignal* The **GET_SIGNAL_SELECTOR** command is used to get the current source of a Signal Selector Control. 
The get_signal_selector command returns the source of a Signal Selector for the currently active Configuration.


try {
    $result = $api_instance->getDescSignalSelector($deviceId, $cfgIdx, $selectorIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SignalSelectorApi->getDescSignalSelector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SignalSelectorApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SignalSelectorApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $selectorIdx = 0; # Integer | Valid top level descriptor index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*currentSignal* The **GET_SIGNAL_SELECTOR** command is used to get the current source of a Signal Selector Control. 
The get_signal_selector command returns the source of a Signal Selector for the currently active Configuration.


eval { 
    my $result = $api_instance->getDescSignalSelector(deviceId => $deviceId, cfgIdx => $cfgIdx, selectorIdx => $selectorIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SignalSelectorApi->getDescSignalSelector: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SignalSelectorApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
selectorIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*currentSignal* The **GET_SIGNAL_SELECTOR** command is used to get the current source of a Signal Selector Control. 
The get_signal_selector command returns the source of a Signal Selector for the currently active Configuration.
 (optional) (default to null)

try: 
    # Get control Descriptor
    api_response = api_instance.get_desc_signal_selector(deviceId, cfgIdx, selectorIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SignalSelectorApi->getDescSignalSelector: %s\n" % e)
extern crate SignalSelectorApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let selectorIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = SignalSelectorApi::Context::default();
    let result = client.getDescSignalSelector(deviceId, cfgIdx, selectorIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
selector_idx*
Integer
Valid top level descriptor index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on. *currentSignal* The **GET_SIGNAL_SELECTOR** command is used to get the current source of a Signal Selector Control. The get_signal_selector command returns the source of a Signal Selector for the currently active Configuration.

Responses


modifyDescSignalSelector

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command. *currentSignal* The **SET_SIGNAL_SELECTOR** command is used to change the signal source of a Signal Selector Control. The set_signal_selector command acts on a SIGNAL_SELECTOR descriptor in the current Configuration. An AVDECC Entity may propagate the selection change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. For valid values, please refer to the descriptor.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalSelector/{selector_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalSelector/{selector_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SignalSelectorApi;

import java.io.File;
import java.util.*;

public class SignalSelectorApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SignalSelectorApi apiInstance = new SignalSelectorApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer selectorIdx = 0; // Integer | Valid top level descriptor index

        SIGNALSELECTOR sIGNALSELECTOR = {SIGNAL_SELECTOR={objectName=Selector 0}}; // SIGNALSELECTOR | 
        
        try {
            SIGNAL_SELECTOR result = apiInstance.modifyDescSignalSelector(deviceId, cfgIdx, selectorIdx, sIGNALSELECTOR);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalSelectorApi#modifyDescSignalSelector");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SignalSelectorApi;

public class SignalSelectorApiExample {
    public static void main(String[] args) {
        SignalSelectorApi apiInstance = new SignalSelectorApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer selectorIdx = 0; // Integer | Valid top level descriptor index

        SIGNALSELECTOR sIGNALSELECTOR = {SIGNAL_SELECTOR={objectName=Selector 0}}; // SIGNALSELECTOR | 
        
        try {
            SIGNAL_SELECTOR result = apiInstance.modifyDescSignalSelector(deviceId, cfgIdx, selectorIdx, sIGNALSELECTOR);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalSelectorApi#modifyDescSignalSelector");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SignalSelectorApi *apiInstance = [[SignalSelectorApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *selectorIdx = 0; // Valid top level descriptor index
 (default to null)
SIGNALSELECTOR *sIGNALSELECTOR = {SIGNAL_SELECTOR={objectName=Selector 0}}; //  (optional)

// modify Descriptor variable Values
[apiInstance modifyDescSignalSelectorWith:deviceId
    cfgIdx:cfgIdx
    selectorIdx:selectorIdx
    sIGNALSELECTOR:sIGNALSELECTOR
              completionHandler: ^(SIGNAL_SELECTOR output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SignalSelectorApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var selectorIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'sIGNALSELECTOR': {SIGNAL_SELECTOR={objectName=Selector 0}} // {SIGNALSELECTOR} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyDescSignalSelector(deviceId, cfgIdx, selectorIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyDescSignalSelectorExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SignalSelectorApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var selectorIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var sIGNALSELECTOR = new SIGNALSELECTOR(); // SIGNALSELECTOR |  (optional) 

            try {
                // modify Descriptor variable Values
                SIGNAL_SELECTOR result = apiInstance.modifyDescSignalSelector(deviceId, cfgIdx, selectorIdx, sIGNALSELECTOR);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SignalSelectorApi.modifyDescSignalSelector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SignalSelectorApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$selectorIdx = 0; // Integer | Valid top level descriptor index

$sIGNALSELECTOR = {SIGNAL_SELECTOR={objectName=Selector 0}}; // SIGNALSELECTOR | 

try {
    $result = $api_instance->modifyDescSignalSelector($deviceId, $cfgIdx, $selectorIdx, $sIGNALSELECTOR);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SignalSelectorApi->modifyDescSignalSelector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SignalSelectorApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SignalSelectorApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $selectorIdx = 0; # Integer | Valid top level descriptor index

my $sIGNALSELECTOR = WWW::OPenAPIClient::Object::SIGNALSELECTOR->new(); # SIGNALSELECTOR | 

eval { 
    my $result = $api_instance->modifyDescSignalSelector(deviceId => $deviceId, cfgIdx => $cfgIdx, selectorIdx => $selectorIdx, sIGNALSELECTOR => $sIGNALSELECTOR);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SignalSelectorApi->modifyDescSignalSelector: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SignalSelectorApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
selectorIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
sIGNALSELECTOR = {SIGNAL_SELECTOR={objectName=Selector 0}} # SIGNALSELECTOR |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.modify_desc_signal_selector(deviceId, cfgIdx, selectorIdx, sIGNALSELECTOR=sIGNALSELECTOR)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SignalSelectorApi->modifyDescSignalSelector: %s\n" % e)
extern crate SignalSelectorApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let selectorIdx = 0; // Integer
    let sIGNALSELECTOR = {SIGNAL_SELECTOR={objectName=Selector 0}}; // SIGNALSELECTOR

    let mut context = SignalSelectorApi::Context::default();
    let result = client.modifyDescSignalSelector(deviceId, cfgIdx, selectorIdx, sIGNALSELECTOR, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
selector_idx*
Integer
Valid top level descriptor index
Required
Body parameters
Name Description
sIGNALSELECTOR

Patch variable Values

Responses


writeDescSignalSelector

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalSelector/{selector_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalSelector/{selector_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SignalSelectorApi;

import java.io.File;
import java.util.*;

public class SignalSelectorApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SignalSelectorApi apiInstance = new SignalSelectorApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer selectorIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            SIGNAL_SELECTOR result = apiInstance.writeDescSignalSelector(deviceId, cfgIdx, selectorIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalSelectorApi#writeDescSignalSelector");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SignalSelectorApi;

public class SignalSelectorApiExample {
    public static void main(String[] args) {
        SignalSelectorApi apiInstance = new SignalSelectorApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer selectorIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            SIGNAL_SELECTOR result = apiInstance.writeDescSignalSelector(deviceId, cfgIdx, selectorIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalSelectorApi#writeDescSignalSelector");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SignalSelectorApi *apiInstance = [[SignalSelectorApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *selectorIdx = 0; // Valid top level descriptor index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance writeDescSignalSelectorWith:deviceId
    cfgIdx:cfgIdx
    selectorIdx:selectorIdx
    length:length
    data:data
              completionHandler: ^(SIGNAL_SELECTOR output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SignalSelectorApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var selectorIdx = 0; // {Integer} Valid top level descriptor index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescSignalSelector(deviceId, cfgIdx, selectorIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescSignalSelectorExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SignalSelectorApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var selectorIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                SIGNAL_SELECTOR result = apiInstance.writeDescSignalSelector(deviceId, cfgIdx, selectorIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SignalSelectorApi.writeDescSignalSelector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SignalSelectorApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$selectorIdx = 0; // Integer | Valid top level descriptor index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescSignalSelector($deviceId, $cfgIdx, $selectorIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SignalSelectorApi->writeDescSignalSelector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SignalSelectorApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SignalSelectorApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $selectorIdx = 0; # Integer | Valid top level descriptor index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescSignalSelector(deviceId => $deviceId, cfgIdx => $cfgIdx, selectorIdx => $selectorIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SignalSelectorApi->writeDescSignalSelector: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SignalSelectorApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
selectorIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.write_desc_signal_selector(deviceId, cfgIdx, selectorIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SignalSelectorApi->writeDescSignalSelector: %s\n" % e)
extern crate SignalSelectorApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let selectorIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = SignalSelectorApi::Context::default();
    let result = client.writeDescSignalSelector(deviceId, cfgIdx, selectorIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
selector_idx*
Integer
Valid top level descriptor index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


SignalSplitter

getDescSignalSplitter

Get signalSplitter Descriptor


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalSplitter/{splitter_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalSplitter/{splitter_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SignalSplitterApi;

import java.io.File;
import java.util.*;

public class SignalSplitterApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SignalSplitterApi apiInstance = new SignalSplitterApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer splitterIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            SIGNAL_SPLITTER result = apiInstance.getDescSignalSplitter(deviceId, cfgIdx, splitterIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalSplitterApi#getDescSignalSplitter");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SignalSplitterApi;

public class SignalSplitterApiExample {
    public static void main(String[] args) {
        SignalSplitterApi apiInstance = new SignalSplitterApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer splitterIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            SIGNAL_SPLITTER result = apiInstance.getDescSignalSplitter(deviceId, cfgIdx, splitterIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalSplitterApi#getDescSignalSplitter");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SignalSplitterApi *apiInstance = [[SignalSplitterApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *splitterIdx = 0; // Valid top level descriptor index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

// Get signalSplitter Descriptor
[apiInstance getDescSignalSplitterWith:deviceId
    cfgIdx:cfgIdx
    splitterIdx:splitterIdx
    entity:entity
              completionHandler: ^(SIGNAL_SPLITTER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SignalSplitterApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var splitterIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescSignalSplitter(deviceId, cfgIdx, splitterIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescSignalSplitterExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SignalSplitterApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var splitterIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional)  (default to null)

            try {
                // Get signalSplitter Descriptor
                SIGNAL_SPLITTER result = apiInstance.getDescSignalSplitter(deviceId, cfgIdx, splitterIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SignalSplitterApi.getDescSignalSplitter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SignalSplitterApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$splitterIdx = 0; // Integer | Valid top level descriptor index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


try {
    $result = $api_instance->getDescSignalSplitter($deviceId, $cfgIdx, $splitterIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SignalSplitterApi->getDescSignalSplitter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SignalSplitterApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SignalSplitterApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $splitterIdx = 0; # Integer | Valid top level descriptor index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


eval { 
    my $result = $api_instance->getDescSignalSplitter(deviceId => $deviceId, cfgIdx => $cfgIdx, splitterIdx => $splitterIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SignalSplitterApi->getDescSignalSplitter: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SignalSplitterApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
splitterIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

try: 
    # Get signalSplitter Descriptor
    api_response = api_instance.get_desc_signal_splitter(deviceId, cfgIdx, splitterIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SignalSplitterApi->getDescSignalSplitter: %s\n" % e)
extern crate SignalSplitterApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let splitterIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = SignalSplitterApi::Context::default();
    let result = client.getDescSignalSplitter(deviceId, cfgIdx, splitterIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
splitter_idx*
Integer
Valid top level descriptor index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

Responses


modifyDescSignalSplitter

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalSplitter/{splitter_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalSplitter/{splitter_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SignalSplitterApi;

import java.io.File;
import java.util.*;

public class SignalSplitterApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SignalSplitterApi apiInstance = new SignalSplitterApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer splitterIdx = 0; // Integer | Valid top level descriptor index

        SIGNALSPLITTER1 sIGNALSPLITTER1 = {SIGNAL_SPLITTER={objectName=Splitter 0}}; // SIGNALSPLITTER1 | 
        
        try {
            SIGNAL_SPLITTER result = apiInstance.modifyDescSignalSplitter(deviceId, cfgIdx, splitterIdx, sIGNALSPLITTER1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalSplitterApi#modifyDescSignalSplitter");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SignalSplitterApi;

public class SignalSplitterApiExample {
    public static void main(String[] args) {
        SignalSplitterApi apiInstance = new SignalSplitterApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer splitterIdx = 0; // Integer | Valid top level descriptor index

        SIGNALSPLITTER1 sIGNALSPLITTER1 = {SIGNAL_SPLITTER={objectName=Splitter 0}}; // SIGNALSPLITTER1 | 
        
        try {
            SIGNAL_SPLITTER result = apiInstance.modifyDescSignalSplitter(deviceId, cfgIdx, splitterIdx, sIGNALSPLITTER1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalSplitterApi#modifyDescSignalSplitter");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SignalSplitterApi *apiInstance = [[SignalSplitterApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *splitterIdx = 0; // Valid top level descriptor index
 (default to null)
SIGNALSPLITTER1 *sIGNALSPLITTER1 = {SIGNAL_SPLITTER={objectName=Splitter 0}}; //  (optional)

// modify Descriptor variable Values
[apiInstance modifyDescSignalSplitterWith:deviceId
    cfgIdx:cfgIdx
    splitterIdx:splitterIdx
    sIGNALSPLITTER1:sIGNALSPLITTER1
              completionHandler: ^(SIGNAL_SPLITTER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SignalSplitterApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var splitterIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'sIGNALSPLITTER1': {SIGNAL_SPLITTER={objectName=Splitter 0}} // {SIGNALSPLITTER1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyDescSignalSplitter(deviceId, cfgIdx, splitterIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyDescSignalSplitterExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SignalSplitterApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var splitterIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var sIGNALSPLITTER1 = new SIGNALSPLITTER1(); // SIGNALSPLITTER1 |  (optional) 

            try {
                // modify Descriptor variable Values
                SIGNAL_SPLITTER result = apiInstance.modifyDescSignalSplitter(deviceId, cfgIdx, splitterIdx, sIGNALSPLITTER1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SignalSplitterApi.modifyDescSignalSplitter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SignalSplitterApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$splitterIdx = 0; // Integer | Valid top level descriptor index

$sIGNALSPLITTER1 = {SIGNAL_SPLITTER={objectName=Splitter 0}}; // SIGNALSPLITTER1 | 

try {
    $result = $api_instance->modifyDescSignalSplitter($deviceId, $cfgIdx, $splitterIdx, $sIGNALSPLITTER1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SignalSplitterApi->modifyDescSignalSplitter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SignalSplitterApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SignalSplitterApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $splitterIdx = 0; # Integer | Valid top level descriptor index

my $sIGNALSPLITTER1 = WWW::OPenAPIClient::Object::SIGNALSPLITTER1->new(); # SIGNALSPLITTER1 | 

eval { 
    my $result = $api_instance->modifyDescSignalSplitter(deviceId => $deviceId, cfgIdx => $cfgIdx, splitterIdx => $splitterIdx, sIGNALSPLITTER1 => $sIGNALSPLITTER1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SignalSplitterApi->modifyDescSignalSplitter: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SignalSplitterApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
splitterIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
sIGNALSPLITTER1 = {SIGNAL_SPLITTER={objectName=Splitter 0}} # SIGNALSPLITTER1 |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.modify_desc_signal_splitter(deviceId, cfgIdx, splitterIdx, sIGNALSPLITTER1=sIGNALSPLITTER1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SignalSplitterApi->modifyDescSignalSplitter: %s\n" % e)
extern crate SignalSplitterApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let splitterIdx = 0; // Integer
    let sIGNALSPLITTER1 = {SIGNAL_SPLITTER={objectName=Splitter 0}}; // SIGNALSPLITTER1

    let mut context = SignalSplitterApi::Context::default();
    let result = client.modifyDescSignalSplitter(deviceId, cfgIdx, splitterIdx, sIGNALSPLITTER1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
splitter_idx*
Integer
Valid top level descriptor index
Required
Body parameters
Name Description
sIGNALSPLITTER1

Set Object Name

Responses


writeDescSignalSplitter

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalSplitter/{splitter_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalSplitter/{splitter_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SignalSplitterApi;

import java.io.File;
import java.util.*;

public class SignalSplitterApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SignalSplitterApi apiInstance = new SignalSplitterApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer splitterIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            SIGNAL_SPLITTER result = apiInstance.writeDescSignalSplitter(deviceId, cfgIdx, splitterIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalSplitterApi#writeDescSignalSplitter");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SignalSplitterApi;

public class SignalSplitterApiExample {
    public static void main(String[] args) {
        SignalSplitterApi apiInstance = new SignalSplitterApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer splitterIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            SIGNAL_SPLITTER result = apiInstance.writeDescSignalSplitter(deviceId, cfgIdx, splitterIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalSplitterApi#writeDescSignalSplitter");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SignalSplitterApi *apiInstance = [[SignalSplitterApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *splitterIdx = 0; // Valid top level descriptor index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance writeDescSignalSplitterWith:deviceId
    cfgIdx:cfgIdx
    splitterIdx:splitterIdx
    length:length
    data:data
              completionHandler: ^(SIGNAL_SPLITTER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SignalSplitterApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var splitterIdx = 0; // {Integer} Valid top level descriptor index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescSignalSplitter(deviceId, cfgIdx, splitterIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescSignalSplitterExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SignalSplitterApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var splitterIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                SIGNAL_SPLITTER result = apiInstance.writeDescSignalSplitter(deviceId, cfgIdx, splitterIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SignalSplitterApi.writeDescSignalSplitter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SignalSplitterApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$splitterIdx = 0; // Integer | Valid top level descriptor index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescSignalSplitter($deviceId, $cfgIdx, $splitterIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SignalSplitterApi->writeDescSignalSplitter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SignalSplitterApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SignalSplitterApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $splitterIdx = 0; # Integer | Valid top level descriptor index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescSignalSplitter(deviceId => $deviceId, cfgIdx => $cfgIdx, splitterIdx => $splitterIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SignalSplitterApi->writeDescSignalSplitter: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SignalSplitterApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
splitterIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.write_desc_signal_splitter(deviceId, cfgIdx, splitterIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SignalSplitterApi->writeDescSignalSplitter: %s\n" % e)
extern crate SignalSplitterApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let splitterIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = SignalSplitterApi::Context::default();
    let result = client.writeDescSignalSplitter(deviceId, cfgIdx, splitterIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
splitter_idx*
Integer
Valid top level descriptor index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


SignalTranscoder

getDescSignalTranscoder

Get signalTranscoder Descriptor


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalTranscoder/{transcoder_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalTranscoder/{transcoder_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SignalTranscoderApi;

import java.io.File;
import java.util.*;

public class SignalTranscoderApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SignalTranscoderApi apiInstance = new SignalTranscoderApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer transcoderIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            SIGNAL_TRANSCODER result = apiInstance.getDescSignalTranscoder(deviceId, cfgIdx, transcoderIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalTranscoderApi#getDescSignalTranscoder");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SignalTranscoderApi;

public class SignalTranscoderApiExample {
    public static void main(String[] args) {
        SignalTranscoderApi apiInstance = new SignalTranscoderApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer transcoderIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

        
        try {
            SIGNAL_TRANSCODER result = apiInstance.getDescSignalTranscoder(deviceId, cfgIdx, transcoderIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalTranscoderApi#getDescSignalTranscoder");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SignalTranscoderApi *apiInstance = [[SignalTranscoderApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *transcoderIdx = 0; // Valid top level descriptor index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

// Get signalTranscoder Descriptor
[apiInstance getDescSignalTranscoderWith:deviceId
    cfgIdx:cfgIdx
    transcoderIdx:transcoderIdx
    entity:entity
              completionHandler: ^(SIGNAL_TRANSCODER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SignalTranscoderApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var transcoderIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescSignalTranscoder(deviceId, cfgIdx, transcoderIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescSignalTranscoderExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SignalTranscoderApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var transcoderIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional)  (default to null)

            try {
                // Get signalTranscoder Descriptor
                SIGNAL_TRANSCODER result = apiInstance.getDescSignalTranscoder(deviceId, cfgIdx, transcoderIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SignalTranscoderApi.getDescSignalTranscoder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SignalTranscoderApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$transcoderIdx = 0; // Integer | Valid top level descriptor index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


try {
    $result = $api_instance->getDescSignalTranscoder($deviceId, $cfgIdx, $transcoderIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SignalTranscoderApi->getDescSignalTranscoder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SignalTranscoderApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SignalTranscoderApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $transcoderIdx = 0; # Integer | Valid top level descriptor index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.


eval { 
    my $result = $api_instance->getDescSignalTranscoder(deviceId => $deviceId, cfgIdx => $cfgIdx, transcoderIdx => $transcoderIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SignalTranscoderApi->getDescSignalTranscoder: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SignalTranscoderApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
transcoderIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.
 (optional) (default to null)

try: 
    # Get signalTranscoder Descriptor
    api_response = api_instance.get_desc_signal_transcoder(deviceId, cfgIdx, transcoderIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SignalTranscoderApi->getDescSignalTranscoder: %s\n" % e)
extern crate SignalTranscoderApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let transcoderIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = SignalTranscoderApi::Context::default();
    let result = client.getDescSignalTranscoder(deviceId, cfgIdx, transcoderIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
transcoder_idx*
Integer
Valid top level descriptor index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

Responses


modifyDescSignalTranscoder

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalTranscoder/{transcoder_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalTranscoder/{transcoder_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SignalTranscoderApi;

import java.io.File;
import java.util.*;

public class SignalTranscoderApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SignalTranscoderApi apiInstance = new SignalTranscoderApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer transcoderIdx = 0; // Integer | Valid top level descriptor index

        SIGNALTRANSCODER1 sIGNALTRANSCODER1 = {SIGNAL_TRANSCODER={objectName=Transcoder 0}}; // SIGNALTRANSCODER1 | 
        
        try {
            SIGNAL_TRANSCODER result = apiInstance.modifyDescSignalTranscoder(deviceId, cfgIdx, transcoderIdx, sIGNALTRANSCODER1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalTranscoderApi#modifyDescSignalTranscoder");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SignalTranscoderApi;

public class SignalTranscoderApiExample {
    public static void main(String[] args) {
        SignalTranscoderApi apiInstance = new SignalTranscoderApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer transcoderIdx = 0; // Integer | Valid top level descriptor index

        SIGNALTRANSCODER1 sIGNALTRANSCODER1 = {SIGNAL_TRANSCODER={objectName=Transcoder 0}}; // SIGNALTRANSCODER1 | 
        
        try {
            SIGNAL_TRANSCODER result = apiInstance.modifyDescSignalTranscoder(deviceId, cfgIdx, transcoderIdx, sIGNALTRANSCODER1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalTranscoderApi#modifyDescSignalTranscoder");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SignalTranscoderApi *apiInstance = [[SignalTranscoderApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *transcoderIdx = 0; // Valid top level descriptor index
 (default to null)
SIGNALTRANSCODER1 *sIGNALTRANSCODER1 = {SIGNAL_TRANSCODER={objectName=Transcoder 0}}; //  (optional)

// modify Descriptor variable Values
[apiInstance modifyDescSignalTranscoderWith:deviceId
    cfgIdx:cfgIdx
    transcoderIdx:transcoderIdx
    sIGNALTRANSCODER1:sIGNALTRANSCODER1
              completionHandler: ^(SIGNAL_TRANSCODER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SignalTranscoderApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var transcoderIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'sIGNALTRANSCODER1': {SIGNAL_TRANSCODER={objectName=Transcoder 0}} // {SIGNALTRANSCODER1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyDescSignalTranscoder(deviceId, cfgIdx, transcoderIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyDescSignalTranscoderExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SignalTranscoderApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var transcoderIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var sIGNALTRANSCODER1 = new SIGNALTRANSCODER1(); // SIGNALTRANSCODER1 |  (optional) 

            try {
                // modify Descriptor variable Values
                SIGNAL_TRANSCODER result = apiInstance.modifyDescSignalTranscoder(deviceId, cfgIdx, transcoderIdx, sIGNALTRANSCODER1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SignalTranscoderApi.modifyDescSignalTranscoder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SignalTranscoderApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$transcoderIdx = 0; // Integer | Valid top level descriptor index

$sIGNALTRANSCODER1 = {SIGNAL_TRANSCODER={objectName=Transcoder 0}}; // SIGNALTRANSCODER1 | 

try {
    $result = $api_instance->modifyDescSignalTranscoder($deviceId, $cfgIdx, $transcoderIdx, $sIGNALTRANSCODER1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SignalTranscoderApi->modifyDescSignalTranscoder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SignalTranscoderApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SignalTranscoderApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $transcoderIdx = 0; # Integer | Valid top level descriptor index

my $sIGNALTRANSCODER1 = WWW::OPenAPIClient::Object::SIGNALTRANSCODER1->new(); # SIGNALTRANSCODER1 | 

eval { 
    my $result = $api_instance->modifyDescSignalTranscoder(deviceId => $deviceId, cfgIdx => $cfgIdx, transcoderIdx => $transcoderIdx, sIGNALTRANSCODER1 => $sIGNALTRANSCODER1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SignalTranscoderApi->modifyDescSignalTranscoder: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SignalTranscoderApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
transcoderIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
sIGNALTRANSCODER1 = {SIGNAL_TRANSCODER={objectName=Transcoder 0}} # SIGNALTRANSCODER1 |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.modify_desc_signal_transcoder(deviceId, cfgIdx, transcoderIdx, sIGNALTRANSCODER1=sIGNALTRANSCODER1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SignalTranscoderApi->modifyDescSignalTranscoder: %s\n" % e)
extern crate SignalTranscoderApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let transcoderIdx = 0; // Integer
    let sIGNALTRANSCODER1 = {SIGNAL_TRANSCODER={objectName=Transcoder 0}}; // SIGNALTRANSCODER1

    let mut context = SignalTranscoderApi::Context::default();
    let result = client.modifyDescSignalTranscoder(deviceId, cfgIdx, transcoderIdx, sIGNALTRANSCODER1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
transcoder_idx*
Integer
Valid top level descriptor index
Required
Body parameters
Name Description
sIGNALTRANSCODER1

Set Object Name

Responses


writeDescSignalTranscoder

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalTranscoder/{transcoder_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/signalTranscoder/{transcoder_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SignalTranscoderApi;

import java.io.File;
import java.util.*;

public class SignalTranscoderApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        SignalTranscoderApi apiInstance = new SignalTranscoderApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer transcoderIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            SIGNAL_TRANSCODER result = apiInstance.writeDescSignalTranscoder(deviceId, cfgIdx, transcoderIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalTranscoderApi#writeDescSignalTranscoder");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SignalTranscoderApi;

public class SignalTranscoderApiExample {
    public static void main(String[] args) {
        SignalTranscoderApi apiInstance = new SignalTranscoderApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer transcoderIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            SIGNAL_TRANSCODER result = apiInstance.writeDescSignalTranscoder(deviceId, cfgIdx, transcoderIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SignalTranscoderApi#writeDescSignalTranscoder");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SignalTranscoderApi *apiInstance = [[SignalTranscoderApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *transcoderIdx = 0; // Valid top level descriptor index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance writeDescSignalTranscoderWith:deviceId
    cfgIdx:cfgIdx
    transcoderIdx:transcoderIdx
    length:length
    data:data
              completionHandler: ^(SIGNAL_TRANSCODER output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.SignalTranscoderApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var transcoderIdx = 0; // {Integer} Valid top level descriptor index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescSignalTranscoder(deviceId, cfgIdx, transcoderIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescSignalTranscoderExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new SignalTranscoderApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var transcoderIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                SIGNAL_TRANSCODER result = apiInstance.writeDescSignalTranscoder(deviceId, cfgIdx, transcoderIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SignalTranscoderApi.writeDescSignalTranscoder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SignalTranscoderApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$transcoderIdx = 0; // Integer | Valid top level descriptor index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescSignalTranscoder($deviceId, $cfgIdx, $transcoderIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SignalTranscoderApi->writeDescSignalTranscoder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SignalTranscoderApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SignalTranscoderApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $transcoderIdx = 0; # Integer | Valid top level descriptor index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescSignalTranscoder(deviceId => $deviceId, cfgIdx => $cfgIdx, transcoderIdx => $transcoderIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SignalTranscoderApi->writeDescSignalTranscoder: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SignalTranscoderApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
transcoderIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.write_desc_signal_transcoder(deviceId, cfgIdx, transcoderIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SignalTranscoderApi->writeDescSignalTranscoder: %s\n" % e)
extern crate SignalTranscoderApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let transcoderIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = SignalTranscoderApi::Context::default();
    let result = client.writeDescSignalTranscoder(deviceId, cfgIdx, transcoderIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
transcoder_idx*
Integer
Valid top level descriptor index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


StreamInput

disableStreamInputEncryption

Disable Streamencryption

The **DISABLE_STREAM_EMCRYPTION** command is used to switch the Entity from using an encrypted frame for a Stream to using an unencrypted frame. Encryption can only be disabled on a non-Active Stream. If is an Active Stream then the Entity responds with a STREAM_IS_RUNNING status.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/streamInput/{stream_idx}/encryption

Usage and SDK Samples

curl -X DELETE\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/streamInput/{stream_idx}/encryption"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.StreamInputApi;

import java.io.File;
import java.util.*;

public class StreamInputApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        StreamInputApi apiInstance = new StreamInputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer streamIdx = 0; // Integer | Valid top level descriptor index

        
        try {
            inline_response_200_12 result = apiInstance.disableStreamInputEncryption(deviceId, cfgIdx, streamIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamInputApi#disableStreamInputEncryption");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.StreamInputApi;

public class StreamInputApiExample {
    public static void main(String[] args) {
        StreamInputApi apiInstance = new StreamInputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer streamIdx = 0; // Integer | Valid top level descriptor index

        
        try {
            inline_response_200_12 result = apiInstance.disableStreamInputEncryption(deviceId, cfgIdx, streamIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamInputApi#disableStreamInputEncryption");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
StreamInputApi *apiInstance = [[StreamInputApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *streamIdx = 0; // Valid top level descriptor index
 (default to null)

// Disable Streamencryption
[apiInstance disableStreamInputEncryptionWith:deviceId
    cfgIdx:cfgIdx
    streamIdx:streamIdx
              completionHandler: ^(inline_response_200_12 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.StreamInputApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var streamIdx = 0; // {Integer} Valid top level descriptor index


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.disableStreamInputEncryption(deviceId, cfgIdx, streamIdx, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class disableStreamInputEncryptionExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new StreamInputApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var streamIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)

            try {
                // Disable Streamencryption
                inline_response_200_12 result = apiInstance.disableStreamInputEncryption(deviceId, cfgIdx, streamIdx);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling StreamInputApi.disableStreamInputEncryption: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\StreamInputApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$streamIdx = 0; // Integer | Valid top level descriptor index


try {
    $result = $api_instance->disableStreamInputEncryption($deviceId, $cfgIdx, $streamIdx);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StreamInputApi->disableStreamInputEncryption: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::StreamInputApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::StreamInputApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $streamIdx = 0; # Integer | Valid top level descriptor index


eval { 
    my $result = $api_instance->disableStreamInputEncryption(deviceId => $deviceId, cfgIdx => $cfgIdx, streamIdx => $streamIdx);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StreamInputApi->disableStreamInputEncryption: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.StreamInputApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
streamIdx = 0 # Integer | Valid top level descriptor index
 (default to null)

try: 
    # Disable Streamencryption
    api_response = api_instance.disable_stream_input_encryption(deviceId, cfgIdx, streamIdx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StreamInputApi->disableStreamInputEncryption: %s\n" % e)
extern crate StreamInputApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let streamIdx = 0; // Integer

    let mut context = StreamInputApi::Context::default();
    let result = client.disableStreamInputEncryption(deviceId, cfgIdx, streamIdx, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
stream_idx*
Integer
Valid top level descriptor index
Required

Responses


enableStreamInputEncryption

Enable Streamencryption

The **ENABLE_STREAM_ENCRYPTION** command is used to switch the Entity from using an unencrypted frame for a Stream to using an encrypted frame. Encryption can only be enabled on a non-Active Stream. If is an Active Stream then the Entity responds with a STREAM_IS_RUNNING status. The enable_streamEncryption command may be protected by authentication. If this is the case, then the Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/streamInput/{stream_idx}/encryption

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/streamInput/{stream_idx}/encryption"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.StreamInputApi;

import java.io.File;
import java.util.*;

public class StreamInputApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        StreamInputApi apiInstance = new StreamInputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer streamIdx = 0; // Integer | Valid top level descriptor index

        InlineObject41 inlineObject41 = ; // InlineObject41 | 
        
        try {
            inline_response_200_11 result = apiInstance.enableStreamInputEncryption(deviceId, cfgIdx, streamIdx, inlineObject41);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamInputApi#enableStreamInputEncryption");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.StreamInputApi;

public class StreamInputApiExample {
    public static void main(String[] args) {
        StreamInputApi apiInstance = new StreamInputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer streamIdx = 0; // Integer | Valid top level descriptor index

        InlineObject41 inlineObject41 = ; // InlineObject41 | 
        
        try {
            inline_response_200_11 result = apiInstance.enableStreamInputEncryption(deviceId, cfgIdx, streamIdx, inlineObject41);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamInputApi#enableStreamInputEncryption");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
StreamInputApi *apiInstance = [[StreamInputApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *streamIdx = 0; // Valid top level descriptor index
 (default to null)
InlineObject41 *inlineObject41 = ; // 

// Enable Streamencryption
[apiInstance enableStreamInputEncryptionWith:deviceId
    cfgIdx:cfgIdx
    streamIdx:streamIdx
    inlineObject41:inlineObject41
              completionHandler: ^(inline_response_200_11 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.StreamInputApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var streamIdx = 0; // {Integer} Valid top level descriptor index

var inlineObject41 = ; // {InlineObject41} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.enableStreamInputEncryption(deviceId, cfgIdx, streamIdx, inlineObject41, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class enableStreamInputEncryptionExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new StreamInputApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var streamIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var inlineObject41 = new InlineObject41(); // InlineObject41 | 

            try {
                // Enable Streamencryption
                inline_response_200_11 result = apiInstance.enableStreamInputEncryption(deviceId, cfgIdx, streamIdx, inlineObject41);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling StreamInputApi.enableStreamInputEncryption: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\StreamInputApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$streamIdx = 0; // Integer | Valid top level descriptor index

$inlineObject41 = ; // InlineObject41 | 

try {
    $result = $api_instance->enableStreamInputEncryption($deviceId, $cfgIdx, $streamIdx, $inlineObject41);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StreamInputApi->enableStreamInputEncryption: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::StreamInputApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::StreamInputApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $streamIdx = 0; # Integer | Valid top level descriptor index

my $inlineObject41 = WWW::OPenAPIClient::Object::InlineObject41->new(); # InlineObject41 | 

eval { 
    my $result = $api_instance->enableStreamInputEncryption(deviceId => $deviceId, cfgIdx => $cfgIdx, streamIdx => $streamIdx, inlineObject41 => $inlineObject41);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StreamInputApi->enableStreamInputEncryption: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.StreamInputApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
streamIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
inlineObject41 =  # InlineObject41 | 

try: 
    # Enable Streamencryption
    api_response = api_instance.enable_stream_input_encryption(deviceId, cfgIdx, streamIdx, inlineObject41)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StreamInputApi->enableStreamInputEncryption: %s\n" % e)
extern crate StreamInputApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let inlineObject41 = ; // InlineObject41

    let mut context = StreamInputApi::Context::default();
    let result = client.enableStreamInputEncryption(deviceId, cfgIdx, streamIdx, inlineObject41, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
stream_idx*
Integer
Valid top level descriptor index
Required
Body parameters
Name Description
inlineObject41 *

Responses


getDescStreamInput

Get clockDomain Descriptor


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/streamInput/{stream_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/streamInput/{stream_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.StreamInputApi;

import java.io.File;
import java.util.*;

public class StreamInputApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        StreamInputApi apiInstance = new StreamInputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer streamIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*streamFormat* The **GET_STREAM_FORMAT** commands is used to get the format of Stream.

*streamBackup* The **GET_STREAM_BACKUP** command is used to get the backup information for a streamInput.

        
        try {
            STREAM_INPUT result = apiInstance.getDescStreamInput(deviceId, cfgIdx, streamIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamInputApi#getDescStreamInput");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.StreamInputApi;

public class StreamInputApiExample {
    public static void main(String[] args) {
        StreamInputApi apiInstance = new StreamInputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer streamIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*streamFormat* The **GET_STREAM_FORMAT** commands is used to get the format of Stream.

*streamBackup* The **GET_STREAM_BACKUP** command is used to get the backup information for a streamInput.

        
        try {
            STREAM_INPUT result = apiInstance.getDescStreamInput(deviceId, cfgIdx, streamIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamInputApi#getDescStreamInput");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
StreamInputApi *apiInstance = [[StreamInputApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *streamIdx = 0; // Valid top level descriptor index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*streamFormat* The **GET_STREAM_FORMAT** commands is used to get the format of Stream.

*streamBackup* The **GET_STREAM_BACKUP** command is used to get the backup information for a streamInput.
 (optional) (default to null)

// Get clockDomain Descriptor
[apiInstance getDescStreamInputWith:deviceId
    cfgIdx:cfgIdx
    streamIdx:streamIdx
    entity:entity
              completionHandler: ^(STREAM_INPUT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.StreamInputApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var streamIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*streamFormat* The **GET_STREAM_FORMAT** commands is used to get the format of Stream.

*streamBackup* The **GET_STREAM_BACKUP** command is used to get the backup information for a streamInput.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescStreamInput(deviceId, cfgIdx, streamIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescStreamInputExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new StreamInputApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var streamIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*streamFormat* The **GET_STREAM_FORMAT** commands is used to get the format of Stream.

*streamBackup* The **GET_STREAM_BACKUP** command is used to get the backup information for a streamInput.
 (optional)  (default to null)

            try {
                // Get clockDomain Descriptor
                STREAM_INPUT result = apiInstance.getDescStreamInput(deviceId, cfgIdx, streamIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling StreamInputApi.getDescStreamInput: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\StreamInputApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$streamIdx = 0; // Integer | Valid top level descriptor index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*streamFormat* The **GET_STREAM_FORMAT** commands is used to get the format of Stream.

*streamBackup* The **GET_STREAM_BACKUP** command is used to get the backup information for a streamInput.


try {
    $result = $api_instance->getDescStreamInput($deviceId, $cfgIdx, $streamIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StreamInputApi->getDescStreamInput: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::StreamInputApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::StreamInputApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $streamIdx = 0; # Integer | Valid top level descriptor index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*streamFormat* The **GET_STREAM_FORMAT** commands is used to get the format of Stream.

*streamBackup* The **GET_STREAM_BACKUP** command is used to get the backup information for a streamInput.


eval { 
    my $result = $api_instance->getDescStreamInput(deviceId => $deviceId, cfgIdx => $cfgIdx, streamIdx => $streamIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StreamInputApi->getDescStreamInput: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.StreamInputApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
streamIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*streamFormat* The **GET_STREAM_FORMAT** commands is used to get the format of Stream.

*streamBackup* The **GET_STREAM_BACKUP** command is used to get the backup information for a streamInput.
 (optional) (default to null)

try: 
    # Get clockDomain Descriptor
    api_response = api_instance.get_desc_stream_input(deviceId, cfgIdx, streamIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StreamInputApi->getDescStreamInput: %s\n" % e)
extern crate StreamInputApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = StreamInputApi::Context::default();
    let result = client.getDescStreamInput(deviceId, cfgIdx, streamIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
stream_idx*
Integer
Valid top level descriptor index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on. *streamFormat* The **GET_STREAM_FORMAT** commands is used to get the format of Stream. *streamBackup* The **GET_STREAM_BACKUP** command is used to get the backup information for a streamInput.

Responses


modifyDescStreamInput

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command. *streamFormat* The **SET_STREAM_FORMAT** command acts on a STREAM_INPUT descriptor in the current Configuration. An AVDECC Entity may propagate the format change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. *streamBackup* The **SET_STREAM_BACKUP** command sets the backup information for the currently active Configuration.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/streamInput/{stream_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/streamInput/{stream_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.StreamInputApi;

import java.io.File;
import java.util.*;

public class StreamInputApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        StreamInputApi apiInstance = new StreamInputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer streamIdx = 0; // Integer | Valid top level descriptor index

        STREAMINPUT1 sTREAMINPUT1 = {STREAM_INPUT={objectName=Stream Input 0}}; // STREAMINPUT1 | 
        
        try {
            STREAM_INPUT result = apiInstance.modifyDescStreamInput(deviceId, cfgIdx, streamIdx, sTREAMINPUT1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamInputApi#modifyDescStreamInput");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.StreamInputApi;

public class StreamInputApiExample {
    public static void main(String[] args) {
        StreamInputApi apiInstance = new StreamInputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer streamIdx = 0; // Integer | Valid top level descriptor index

        STREAMINPUT1 sTREAMINPUT1 = {STREAM_INPUT={objectName=Stream Input 0}}; // STREAMINPUT1 | 
        
        try {
            STREAM_INPUT result = apiInstance.modifyDescStreamInput(deviceId, cfgIdx, streamIdx, sTREAMINPUT1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamInputApi#modifyDescStreamInput");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
StreamInputApi *apiInstance = [[StreamInputApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *streamIdx = 0; // Valid top level descriptor index
 (default to null)
STREAMINPUT1 *sTREAMINPUT1 = {STREAM_INPUT={objectName=Stream Input 0}}; //  (optional)

// modify Descriptor variable Values
[apiInstance modifyDescStreamInputWith:deviceId
    cfgIdx:cfgIdx
    streamIdx:streamIdx
    sTREAMINPUT1:sTREAMINPUT1
              completionHandler: ^(STREAM_INPUT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.StreamInputApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var streamIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'sTREAMINPUT1': {STREAM_INPUT={objectName=Stream Input 0}} // {STREAMINPUT1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyDescStreamInput(deviceId, cfgIdx, streamIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyDescStreamInputExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new StreamInputApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var streamIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var sTREAMINPUT1 = new STREAMINPUT1(); // STREAMINPUT1 |  (optional) 

            try {
                // modify Descriptor variable Values
                STREAM_INPUT result = apiInstance.modifyDescStreamInput(deviceId, cfgIdx, streamIdx, sTREAMINPUT1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling StreamInputApi.modifyDescStreamInput: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\StreamInputApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$streamIdx = 0; // Integer | Valid top level descriptor index

$sTREAMINPUT1 = {STREAM_INPUT={objectName=Stream Input 0}}; // STREAMINPUT1 | 

try {
    $result = $api_instance->modifyDescStreamInput($deviceId, $cfgIdx, $streamIdx, $sTREAMINPUT1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StreamInputApi->modifyDescStreamInput: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::StreamInputApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::StreamInputApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $streamIdx = 0; # Integer | Valid top level descriptor index

my $sTREAMINPUT1 = WWW::OPenAPIClient::Object::STREAMINPUT1->new(); # STREAMINPUT1 | 

eval { 
    my $result = $api_instance->modifyDescStreamInput(deviceId => $deviceId, cfgIdx => $cfgIdx, streamIdx => $streamIdx, sTREAMINPUT1 => $sTREAMINPUT1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StreamInputApi->modifyDescStreamInput: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.StreamInputApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
streamIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
sTREAMINPUT1 = {STREAM_INPUT={objectName=Stream Input 0}} # STREAMINPUT1 |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.modify_desc_stream_input(deviceId, cfgIdx, streamIdx, sTREAMINPUT1=sTREAMINPUT1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StreamInputApi->modifyDescStreamInput: %s\n" % e)
extern crate StreamInputApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let sTREAMINPUT1 = {STREAM_INPUT={objectName=Stream Input 0}}; // STREAMINPUT1

    let mut context = StreamInputApi::Context::default();
    let result = client.modifyDescStreamInput(deviceId, cfgIdx, streamIdx, sTREAMINPUT1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
stream_idx*
Integer
Valid top level descriptor index
Required
Body parameters
Name Description
sTREAMINPUT1

Set Object Name and Control Value

Responses


readStreamInputCounters

Get Counters from Descriptor STREAM_INPUT

The **GET_COUNTERS** command is used to get the performance variables and diagnostics counters. The answer is descriptor specific, see extended documentation.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/streamInput/{stream_idx}/counters

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/streamInput/{stream_idx}/counters"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.StreamInputApi;

import java.io.File;
import java.util.*;

public class StreamInputApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        StreamInputApi apiInstance = new StreamInputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer streamIdx = 0; // Integer | Valid top level descriptor index

        
        try {
            inline_response_200_13 result = apiInstance.readStreamInputCounters(deviceId, cfgIdx, streamIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamInputApi#readStreamInputCounters");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.StreamInputApi;

public class StreamInputApiExample {
    public static void main(String[] args) {
        StreamInputApi apiInstance = new StreamInputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer streamIdx = 0; // Integer | Valid top level descriptor index

        
        try {
            inline_response_200_13 result = apiInstance.readStreamInputCounters(deviceId, cfgIdx, streamIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamInputApi#readStreamInputCounters");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
StreamInputApi *apiInstance = [[StreamInputApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *streamIdx = 0; // Valid top level descriptor index
 (default to null)

// Get Counters from Descriptor STREAM_INPUT
[apiInstance readStreamInputCountersWith:deviceId
    cfgIdx:cfgIdx
    streamIdx:streamIdx
              completionHandler: ^(inline_response_200_13 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.StreamInputApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var streamIdx = 0; // {Integer} Valid top level descriptor index


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readStreamInputCounters(deviceId, cfgIdx, streamIdx, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class readStreamInputCountersExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new StreamInputApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var streamIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)

            try {
                // Get Counters from Descriptor STREAM_INPUT
                inline_response_200_13 result = apiInstance.readStreamInputCounters(deviceId, cfgIdx, streamIdx);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling StreamInputApi.readStreamInputCounters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\StreamInputApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$streamIdx = 0; // Integer | Valid top level descriptor index


try {
    $result = $api_instance->readStreamInputCounters($deviceId, $cfgIdx, $streamIdx);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StreamInputApi->readStreamInputCounters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::StreamInputApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::StreamInputApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $streamIdx = 0; # Integer | Valid top level descriptor index


eval { 
    my $result = $api_instance->readStreamInputCounters(deviceId => $deviceId, cfgIdx => $cfgIdx, streamIdx => $streamIdx);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StreamInputApi->readStreamInputCounters: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.StreamInputApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
streamIdx = 0 # Integer | Valid top level descriptor index
 (default to null)

try: 
    # Get Counters from Descriptor STREAM_INPUT
    api_response = api_instance.read_stream_input_counters(deviceId, cfgIdx, streamIdx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StreamInputApi->readStreamInputCounters: %s\n" % e)
extern crate StreamInputApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let streamIdx = 0; // Integer

    let mut context = StreamInputApi::Context::default();
    let result = client.readStreamInputCounters(deviceId, cfgIdx, streamIdx, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
stream_idx*
Integer
Valid top level descriptor index
Required

Responses


writeDescStreamInput

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/streamInput/{stream_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/streamInput/{stream_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.StreamInputApi;

import java.io.File;
import java.util.*;

public class StreamInputApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        StreamInputApi apiInstance = new StreamInputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer streamIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            STREAM_INPUT result = apiInstance.writeDescStreamInput(deviceId, cfgIdx, streamIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamInputApi#writeDescStreamInput");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.StreamInputApi;

public class StreamInputApiExample {
    public static void main(String[] args) {
        StreamInputApi apiInstance = new StreamInputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer streamIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            STREAM_INPUT result = apiInstance.writeDescStreamInput(deviceId, cfgIdx, streamIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamInputApi#writeDescStreamInput");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
StreamInputApi *apiInstance = [[StreamInputApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *streamIdx = 0; // Valid top level descriptor index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance writeDescStreamInputWith:deviceId
    cfgIdx:cfgIdx
    streamIdx:streamIdx
    length:length
    data:data
              completionHandler: ^(STREAM_INPUT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.StreamInputApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var streamIdx = 0; // {Integer} Valid top level descriptor index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescStreamInput(deviceId, cfgIdx, streamIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescStreamInputExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new StreamInputApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var streamIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                STREAM_INPUT result = apiInstance.writeDescStreamInput(deviceId, cfgIdx, streamIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling StreamInputApi.writeDescStreamInput: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\StreamInputApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$streamIdx = 0; // Integer | Valid top level descriptor index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescStreamInput($deviceId, $cfgIdx, $streamIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StreamInputApi->writeDescStreamInput: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::StreamInputApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::StreamInputApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $streamIdx = 0; # Integer | Valid top level descriptor index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescStreamInput(deviceId => $deviceId, cfgIdx => $cfgIdx, streamIdx => $streamIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StreamInputApi->writeDescStreamInput: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.StreamInputApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
streamIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.write_desc_stream_input(deviceId, cfgIdx, streamIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StreamInputApi->writeDescStreamInput: %s\n" % e)
extern crate StreamInputApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = StreamInputApi::Context::default();
    let result = client.writeDescStreamInput(deviceId, cfgIdx, streamIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
stream_idx*
Integer
Valid top level descriptor index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses


StreamOutput

disableStreamOutputEncryption

Disable Streamencryption

The **DISABLE_STREAM_EMCRYPTION** command is used to switch the Entity from using an encrypted frame for a Stream to using an unencrypted frame. Encryption can only be disabled on a non-Active Stream. If is an Active Stream then the Entity responds with a STREAM_IS_RUNNING status.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/streamOutput/{stream_idx}/encryption

Usage and SDK Samples

curl -X DELETE\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/streamOutput/{stream_idx}/encryption"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.StreamOutputApi;

import java.io.File;
import java.util.*;

public class StreamOutputApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        StreamOutputApi apiInstance = new StreamOutputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer streamIdx = 0; // Integer | Valid top level descriptor index

        
        try {
            inline_response_200_12 result = apiInstance.disableStreamOutputEncryption(deviceId, cfgIdx, streamIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamOutputApi#disableStreamOutputEncryption");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.StreamOutputApi;

public class StreamOutputApiExample {
    public static void main(String[] args) {
        StreamOutputApi apiInstance = new StreamOutputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer streamIdx = 0; // Integer | Valid top level descriptor index

        
        try {
            inline_response_200_12 result = apiInstance.disableStreamOutputEncryption(deviceId, cfgIdx, streamIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamOutputApi#disableStreamOutputEncryption");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
StreamOutputApi *apiInstance = [[StreamOutputApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *streamIdx = 0; // Valid top level descriptor index
 (default to null)

// Disable Streamencryption
[apiInstance disableStreamOutputEncryptionWith:deviceId
    cfgIdx:cfgIdx
    streamIdx:streamIdx
              completionHandler: ^(inline_response_200_12 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.StreamOutputApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var streamIdx = 0; // {Integer} Valid top level descriptor index


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.disableStreamOutputEncryption(deviceId, cfgIdx, streamIdx, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class disableStreamOutputEncryptionExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new StreamOutputApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var streamIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)

            try {
                // Disable Streamencryption
                inline_response_200_12 result = apiInstance.disableStreamOutputEncryption(deviceId, cfgIdx, streamIdx);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling StreamOutputApi.disableStreamOutputEncryption: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\StreamOutputApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$streamIdx = 0; // Integer | Valid top level descriptor index


try {
    $result = $api_instance->disableStreamOutputEncryption($deviceId, $cfgIdx, $streamIdx);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StreamOutputApi->disableStreamOutputEncryption: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::StreamOutputApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::StreamOutputApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $streamIdx = 0; # Integer | Valid top level descriptor index


eval { 
    my $result = $api_instance->disableStreamOutputEncryption(deviceId => $deviceId, cfgIdx => $cfgIdx, streamIdx => $streamIdx);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StreamOutputApi->disableStreamOutputEncryption: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.StreamOutputApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
streamIdx = 0 # Integer | Valid top level descriptor index
 (default to null)

try: 
    # Disable Streamencryption
    api_response = api_instance.disable_stream_output_encryption(deviceId, cfgIdx, streamIdx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StreamOutputApi->disableStreamOutputEncryption: %s\n" % e)
extern crate StreamOutputApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let streamIdx = 0; // Integer

    let mut context = StreamOutputApi::Context::default();
    let result = client.disableStreamOutputEncryption(deviceId, cfgIdx, streamIdx, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
stream_idx*
Integer
Valid top level descriptor index
Required

Responses


enableStreamOutputEncryption

Enable Streamencryption

The **ENABLE_STREAM_ENCRYPTION** command is used to switch the Entity from using an unencrypted frame for a Stream to using an encrypted frame. Encryption can only be enabled on a non-Active Stream. If is an Active Stream then the Entity responds with a STREAM_IS_RUNNING status. The enable_streamEncryption command may be protected by authentication. If this is the case, then the Entity responds with a NOT_AUTHENTICATED status response to an unauthenticated Controller.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/streamOutput/{stream_idx}/encryption

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/streamOutput/{stream_idx}/encryption"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.StreamOutputApi;

import java.io.File;
import java.util.*;

public class StreamOutputApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        StreamOutputApi apiInstance = new StreamOutputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer streamIdx = 0; // Integer | Valid top level descriptor index

        InlineObject43 inlineObject43 = ; // InlineObject43 | 
        
        try {
            inline_response_200_11 result = apiInstance.enableStreamOutputEncryption(deviceId, cfgIdx, streamIdx, inlineObject43);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamOutputApi#enableStreamOutputEncryption");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.StreamOutputApi;

public class StreamOutputApiExample {
    public static void main(String[] args) {
        StreamOutputApi apiInstance = new StreamOutputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer streamIdx = 0; // Integer | Valid top level descriptor index

        InlineObject43 inlineObject43 = ; // InlineObject43 | 
        
        try {
            inline_response_200_11 result = apiInstance.enableStreamOutputEncryption(deviceId, cfgIdx, streamIdx, inlineObject43);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamOutputApi#enableStreamOutputEncryption");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
StreamOutputApi *apiInstance = [[StreamOutputApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *streamIdx = 0; // Valid top level descriptor index
 (default to null)
InlineObject43 *inlineObject43 = ; // 

// Enable Streamencryption
[apiInstance enableStreamOutputEncryptionWith:deviceId
    cfgIdx:cfgIdx
    streamIdx:streamIdx
    inlineObject43:inlineObject43
              completionHandler: ^(inline_response_200_11 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.StreamOutputApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var streamIdx = 0; // {Integer} Valid top level descriptor index

var inlineObject43 = ; // {InlineObject43} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.enableStreamOutputEncryption(deviceId, cfgIdx, streamIdx, inlineObject43, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class enableStreamOutputEncryptionExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new StreamOutputApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var streamIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var inlineObject43 = new InlineObject43(); // InlineObject43 | 

            try {
                // Enable Streamencryption
                inline_response_200_11 result = apiInstance.enableStreamOutputEncryption(deviceId, cfgIdx, streamIdx, inlineObject43);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling StreamOutputApi.enableStreamOutputEncryption: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\StreamOutputApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$streamIdx = 0; // Integer | Valid top level descriptor index

$inlineObject43 = ; // InlineObject43 | 

try {
    $result = $api_instance->enableStreamOutputEncryption($deviceId, $cfgIdx, $streamIdx, $inlineObject43);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StreamOutputApi->enableStreamOutputEncryption: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::StreamOutputApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::StreamOutputApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $streamIdx = 0; # Integer | Valid top level descriptor index

my $inlineObject43 = WWW::OPenAPIClient::Object::InlineObject43->new(); # InlineObject43 | 

eval { 
    my $result = $api_instance->enableStreamOutputEncryption(deviceId => $deviceId, cfgIdx => $cfgIdx, streamIdx => $streamIdx, inlineObject43 => $inlineObject43);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StreamOutputApi->enableStreamOutputEncryption: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.StreamOutputApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
streamIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
inlineObject43 =  # InlineObject43 | 

try: 
    # Enable Streamencryption
    api_response = api_instance.enable_stream_output_encryption(deviceId, cfgIdx, streamIdx, inlineObject43)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StreamOutputApi->enableStreamOutputEncryption: %s\n" % e)
extern crate StreamOutputApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let inlineObject43 = ; // InlineObject43

    let mut context = StreamOutputApi::Context::default();
    let result = client.enableStreamOutputEncryption(deviceId, cfgIdx, streamIdx, inlineObject43, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
stream_idx*
Integer
Valid top level descriptor index
Required
Body parameters
Name Description
inlineObject43 *

Responses


getDescStreamOutput

Get clockDomain Descriptor


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/streamOutput/{stream_idx}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/streamOutput/{stream_idx}?entity="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.StreamOutputApi;

import java.io.File;
import java.util.*;

public class StreamOutputApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        StreamOutputApi apiInstance = new StreamOutputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer streamIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*streamFormat* The **GET_STREAM_FORMAT** commands is used to get the format of Stream.

*streamBackup* The **GET_STREAM_BACKUP** command is used to get the backup information for a streamOutput.

        
        try {
            STREAM_OUTPUT result = apiInstance.getDescStreamOutput(deviceId, cfgIdx, streamIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamOutputApi#getDescStreamOutput");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.StreamOutputApi;

public class StreamOutputApiExample {
    public static void main(String[] args) {
        StreamOutputApi apiInstance = new StreamOutputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer streamIdx = 0; // Integer | Valid top level descriptor index

        array[String] entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*streamFormat* The **GET_STREAM_FORMAT** commands is used to get the format of Stream.

*streamBackup* The **GET_STREAM_BACKUP** command is used to get the backup information for a streamOutput.

        
        try {
            STREAM_OUTPUT result = apiInstance.getDescStreamOutput(deviceId, cfgIdx, streamIdx, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamOutputApi#getDescStreamOutput");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
StreamOutputApi *apiInstance = [[StreamOutputApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *streamIdx = 0; // Valid top level descriptor index
 (default to null)
array[String] *entity = ; // 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*streamFormat* The **GET_STREAM_FORMAT** commands is used to get the format of Stream.

*streamBackup* The **GET_STREAM_BACKUP** command is used to get the backup information for a streamOutput.
 (optional) (default to null)

// Get clockDomain Descriptor
[apiInstance getDescStreamOutputWith:deviceId
    cfgIdx:cfgIdx
    streamIdx:streamIdx
    entity:entity
              completionHandler: ^(STREAM_OUTPUT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.StreamOutputApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var streamIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'entity':  // {array[String]} 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*streamFormat* The **GET_STREAM_FORMAT** commands is used to get the format of Stream.

*streamBackup* The **GET_STREAM_BACKUP** command is used to get the backup information for a streamOutput.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescStreamOutput(deviceId, cfgIdx, streamIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDescStreamOutputExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new StreamOutputApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var streamIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var entity = new array[String](); // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*streamFormat* The **GET_STREAM_FORMAT** commands is used to get the format of Stream.

*streamBackup* The **GET_STREAM_BACKUP** command is used to get the backup information for a streamOutput.
 (optional)  (default to null)

            try {
                // Get clockDomain Descriptor
                STREAM_OUTPUT result = apiInstance.getDescStreamOutput(deviceId, cfgIdx, streamIdx, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling StreamOutputApi.getDescStreamOutput: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\StreamOutputApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$streamIdx = 0; // Integer | Valid top level descriptor index

$entity = ; // array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*streamFormat* The **GET_STREAM_FORMAT** commands is used to get the format of Stream.

*streamBackup* The **GET_STREAM_BACKUP** command is used to get the backup information for a streamOutput.


try {
    $result = $api_instance->getDescStreamOutput($deviceId, $cfgIdx, $streamIdx, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StreamOutputApi->getDescStreamOutput: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::StreamOutputApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::StreamOutputApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $streamIdx = 0; # Integer | Valid top level descriptor index

my $entity = []; # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*streamFormat* The **GET_STREAM_FORMAT** commands is used to get the format of Stream.

*streamBackup* The **GET_STREAM_BACKUP** command is used to get the backup information for a streamOutput.


eval { 
    my $result = $api_instance->getDescStreamOutput(deviceId => $deviceId, cfgIdx => $cfgIdx, streamIdx => $streamIdx, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StreamOutputApi->getDescStreamOutput: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.StreamOutputApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
streamIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
entity =  # array[String] | 
The following objects can be changed and trigger AEM Command on the device.

*descriptor*  The **READ_DESCRIPTOR** command read Data from entity whiteout database

*objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. 
For descriptors with multible names, this sets only one specified name. 
The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on.

*streamFormat* The **GET_STREAM_FORMAT** commands is used to get the format of Stream.

*streamBackup* The **GET_STREAM_BACKUP** command is used to get the backup information for a streamOutput.
 (optional) (default to null)

try: 
    # Get clockDomain Descriptor
    api_response = api_instance.get_desc_stream_output(deviceId, cfgIdx, streamIdx, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StreamOutputApi->getDescStreamOutput: %s\n" % e)
extern crate StreamOutputApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let entity = ; // array[String]

    let mut context = StreamOutputApi::Context::default();
    let result = client.getDescStreamOutput(deviceId, cfgIdx, streamIdx, entity, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
stream_idx*
Integer
Valid top level descriptor index
Required
Query parameters
Name Description
entity
array[String]
The following objects can be changed and trigger AEM Command on the device. *descriptor* The **READ_DESCRIPTOR** command read Data from entity whiteout database *objectName* The **GET_NAME** command is used to get the value of a field within a descriptor. For descriptors with multible names, this sets only one specified name. The name_index field is set to the index of the name witin descriptor, with the first name being index 0, and so on. *streamFormat* The **GET_STREAM_FORMAT** commands is used to get the format of Stream. *streamBackup* The **GET_STREAM_BACKUP** command is used to get the backup information for a streamOutput.

Responses


getStreamOutputStreamStatus

Get streaming status


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/streamOutput/{stream_idx}/stream

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/streamOutput/{stream_idx}/stream"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.StreamOutputApi;

import java.io.File;
import java.util.*;

public class StreamOutputApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        StreamOutputApi apiInstance = new StreamOutputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer streamIdx = 0; // Integer | Valid top level descriptor index

        
        try {
            inline_response_200_14 result = apiInstance.getStreamOutputStreamStatus(deviceId, cfgIdx, streamIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamOutputApi#getStreamOutputStreamStatus");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.StreamOutputApi;

public class StreamOutputApiExample {
    public static void main(String[] args) {
        StreamOutputApi apiInstance = new StreamOutputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer streamIdx = 0; // Integer | Valid top level descriptor index

        
        try {
            inline_response_200_14 result = apiInstance.getStreamOutputStreamStatus(deviceId, cfgIdx, streamIdx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamOutputApi#getStreamOutputStreamStatus");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
StreamOutputApi *apiInstance = [[StreamOutputApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *streamIdx = 0; // Valid top level descriptor index
 (default to null)

// Get streaming status
[apiInstance getStreamOutputStreamStatusWith:deviceId
    cfgIdx:cfgIdx
    streamIdx:streamIdx
              completionHandler: ^(inline_response_200_14 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.StreamOutputApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var streamIdx = 0; // {Integer} Valid top level descriptor index


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStreamOutputStreamStatus(deviceId, cfgIdx, streamIdx, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getStreamOutputStreamStatusExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new StreamOutputApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var streamIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)

            try {
                // Get streaming status
                inline_response_200_14 result = apiInstance.getStreamOutputStreamStatus(deviceId, cfgIdx, streamIdx);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling StreamOutputApi.getStreamOutputStreamStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\StreamOutputApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$streamIdx = 0; // Integer | Valid top level descriptor index


try {
    $result = $api_instance->getStreamOutputStreamStatus($deviceId, $cfgIdx, $streamIdx);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StreamOutputApi->getStreamOutputStreamStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::StreamOutputApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::StreamOutputApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $streamIdx = 0; # Integer | Valid top level descriptor index


eval { 
    my $result = $api_instance->getStreamOutputStreamStatus(deviceId => $deviceId, cfgIdx => $cfgIdx, streamIdx => $streamIdx);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StreamOutputApi->getStreamOutputStreamStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.StreamOutputApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
streamIdx = 0 # Integer | Valid top level descriptor index
 (default to null)

try: 
    # Get streaming status
    api_response = api_instance.get_stream_output_stream_status(deviceId, cfgIdx, streamIdx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StreamOutputApi->getStreamOutputStreamStatus: %s\n" % e)
extern crate StreamOutputApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let streamIdx = 0; // Integer

    let mut context = StreamOutputApi::Context::default();
    let result = client.getStreamOutputStreamStatus(deviceId, cfgIdx, streamIdx, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
stream_idx*
Integer
Valid top level descriptor index
Required

Responses


modifyDescStreamOutput

modify Descriptor variable Values

The following objects can be changed and trigger AEM Command on the device. *objectName* The **SET_NAME** command is used to set set the values of a name field within a descriptor. For descriptors with multible names, this sets only one specfific name per command. *streamFormat* The **SET_STREAM_FORMAT** command acts on a STREAM_OUTPUT descriptor in the current Configuration. An AVDECC Entity may propagate the format change onto corresponding descriptors in other Configurations, but an AVDECC Controller cannot assume that this will happen. *streamBackup* The **SET_STREAM_BACKUP** command sets the backup information for the currently active Configuration.


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/streamOutput/{stream_idx}

Usage and SDK Samples

curl -X PATCH\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/streamOutput/{stream_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.StreamOutputApi;

import java.io.File;
import java.util.*;

public class StreamOutputApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        StreamOutputApi apiInstance = new StreamOutputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer streamIdx = 0; // Integer | Valid top level descriptor index

        STREAMOUTPUT1 sTREAMOUTPUT1 = {STREAM_OUTPUT={objectName=Stream Output 0}}; // STREAMOUTPUT1 | 
        
        try {
            STREAM_OUTPUT result = apiInstance.modifyDescStreamOutput(deviceId, cfgIdx, streamIdx, sTREAMOUTPUT1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamOutputApi#modifyDescStreamOutput");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.StreamOutputApi;

public class StreamOutputApiExample {
    public static void main(String[] args) {
        StreamOutputApi apiInstance = new StreamOutputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer streamIdx = 0; // Integer | Valid top level descriptor index

        STREAMOUTPUT1 sTREAMOUTPUT1 = {STREAM_OUTPUT={objectName=Stream Output 0}}; // STREAMOUTPUT1 | 
        
        try {
            STREAM_OUTPUT result = apiInstance.modifyDescStreamOutput(deviceId, cfgIdx, streamIdx, sTREAMOUTPUT1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamOutputApi#modifyDescStreamOutput");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
StreamOutputApi *apiInstance = [[StreamOutputApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *streamIdx = 0; // Valid top level descriptor index
 (default to null)
STREAMOUTPUT1 *sTREAMOUTPUT1 = {STREAM_OUTPUT={objectName=Stream Output 0}}; //  (optional)

// modify Descriptor variable Values
[apiInstance modifyDescStreamOutputWith:deviceId
    cfgIdx:cfgIdx
    streamIdx:streamIdx
    sTREAMOUTPUT1:sTREAMOUTPUT1
              completionHandler: ^(STREAM_OUTPUT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.StreamOutputApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var streamIdx = 0; // {Integer} Valid top level descriptor index

var opts = {
  'sTREAMOUTPUT1': {STREAM_OUTPUT={objectName=Stream Output 0}} // {STREAMOUTPUT1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyDescStreamOutput(deviceId, cfgIdx, streamIdx, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyDescStreamOutputExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new StreamOutputApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var streamIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var sTREAMOUTPUT1 = new STREAMOUTPUT1(); // STREAMOUTPUT1 |  (optional) 

            try {
                // modify Descriptor variable Values
                STREAM_OUTPUT result = apiInstance.modifyDescStreamOutput(deviceId, cfgIdx, streamIdx, sTREAMOUTPUT1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling StreamOutputApi.modifyDescStreamOutput: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\StreamOutputApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$streamIdx = 0; // Integer | Valid top level descriptor index

$sTREAMOUTPUT1 = {STREAM_OUTPUT={objectName=Stream Output 0}}; // STREAMOUTPUT1 | 

try {
    $result = $api_instance->modifyDescStreamOutput($deviceId, $cfgIdx, $streamIdx, $sTREAMOUTPUT1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StreamOutputApi->modifyDescStreamOutput: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::StreamOutputApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::StreamOutputApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $streamIdx = 0; # Integer | Valid top level descriptor index

my $sTREAMOUTPUT1 = WWW::OPenAPIClient::Object::STREAMOUTPUT1->new(); # STREAMOUTPUT1 | 

eval { 
    my $result = $api_instance->modifyDescStreamOutput(deviceId => $deviceId, cfgIdx => $cfgIdx, streamIdx => $streamIdx, sTREAMOUTPUT1 => $sTREAMOUTPUT1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StreamOutputApi->modifyDescStreamOutput: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.StreamOutputApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
streamIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
sTREAMOUTPUT1 = {STREAM_OUTPUT={objectName=Stream Output 0}} # STREAMOUTPUT1 |  (optional)

try: 
    # modify Descriptor variable Values
    api_response = api_instance.modify_desc_stream_output(deviceId, cfgIdx, streamIdx, sTREAMOUTPUT1=sTREAMOUTPUT1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StreamOutputApi->modifyDescStreamOutput: %s\n" % e)
extern crate StreamOutputApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let sTREAMOUTPUT1 = {STREAM_OUTPUT={objectName=Stream Output 0}}; // STREAMOUTPUT1

    let mut context = StreamOutputApi::Context::default();
    let result = client.modifyDescStreamOutput(deviceId, cfgIdx, streamIdx, sTREAMOUTPUT1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
stream_idx*
Integer
Valid top level descriptor index
Required
Body parameters
Name Description
sTREAMOUTPUT1

Set Object Name and Control Value

Responses


writeDescStreamOutput

Write Descriptor in device

The **WRITE_DESCRIPTOR** command is used to update an Configuration descriptor. An Entity does not have to support writing of a descriptor. If the Entity is locked or acqurired, then writing adescriptor can only by perform by the Controller whitch has the lock or acqusition. Caution, the sturture may then be invalid, most devices do not support this command. The written descriptor or an error code is returned


/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/streamOutput/{stream_idx}

Usage and SDK Samples

curl -X PUT\
 -H "Accept: application/json"\
 -H "Content-Type: application/x-www-form-urlencoded"\
 "http://localhost:7778/avb/v1.0/devices/{deviceId}/descriptor/entity/configuration/{cfg_idx}/streamOutput/{stream_idx}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.StreamOutputApi;

import java.io.File;
import java.util.*;

public class StreamOutputApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        StreamOutputApi apiInstance = new StreamOutputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer streamIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            STREAM_OUTPUT result = apiInstance.writeDescStreamOutput(deviceId, cfgIdx, streamIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamOutputApi#writeDescStreamOutput");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.StreamOutputApi;

public class StreamOutputApiExample {
    public static void main(String[] args) {
        StreamOutputApi apiInstance = new StreamOutputApi();
        String deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

        Integer cfgIdx = 0; // Integer | valid configurations index

        Integer streamIdx = 0; // Integer | Valid top level descriptor index

        Integer length = 56; // Integer | data length uncoded
        String data = data_example; // String | 
        
        try {
            STREAM_OUTPUT result = apiInstance.writeDescStreamOutput(deviceId, cfgIdx, streamIdx, length, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamOutputApi#writeDescStreamOutput");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
StreamOutputApi *apiInstance = [[StreamOutputApi alloc] init];
String *deviceId = 00-50-c2-ff-fe-d4-33-8d; // Entity device identifier
 (default to null)
Integer *cfgIdx = 0; // valid configurations index
 (default to null)
Integer *streamIdx = 0; // Valid top level descriptor index
 (default to null)
Integer *length = 56; // data length uncoded (default to null)
String *data = data_example; //  (default to null)

// Write Descriptor in device
[apiInstance writeDescStreamOutputWith:deviceId
    cfgIdx:cfgIdx
    streamIdx:streamIdx
    length:length
    data:data
              completionHandler: ^(STREAM_OUTPUT output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var RestIeee17221TsnController = require('rest_ieee_1722_1_tsn_controller');

// Create an instance of the API class
var api = new RestIeee17221TsnController.StreamOutputApi()
var deviceId = 00-50-c2-ff-fe-d4-33-8d; // {String} Entity device identifier

var cfgIdx = 0; // {Integer} valid configurations index

var streamIdx = 0; // {Integer} Valid top level descriptor index

var length = 56; // {Integer} data length uncoded
var data = data_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.writeDescStreamOutput(deviceId, cfgIdx, streamIdx, length, data, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class writeDescStreamOutputExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new StreamOutputApi();
            var deviceId = 00-50-c2-ff-fe-d4-33-8d;  // String | Entity device identifier
 (default to null)
            var cfgIdx = 0;  // Integer | valid configurations index
 (default to null)
            var streamIdx = 0;  // Integer | Valid top level descriptor index
 (default to null)
            var length = 56;  // Integer | data length uncoded (default to null)
            var data = data_example;  // String |  (default to null)

            try {
                // Write Descriptor in device
                STREAM_OUTPUT result = apiInstance.writeDescStreamOutput(deviceId, cfgIdx, streamIdx, length, data);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling StreamOutputApi.writeDescStreamOutput: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\StreamOutputApi();
$deviceId = 00-50-c2-ff-fe-d4-33-8d; // String | Entity device identifier

$cfgIdx = 0; // Integer | valid configurations index

$streamIdx = 0; // Integer | Valid top level descriptor index

$length = 56; // Integer | data length uncoded
$data = data_example; // String | 

try {
    $result = $api_instance->writeDescStreamOutput($deviceId, $cfgIdx, $streamIdx, $length, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StreamOutputApi->writeDescStreamOutput: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::StreamOutputApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::StreamOutputApi->new();
my $deviceId = 00-50-c2-ff-fe-d4-33-8d; # String | Entity device identifier

my $cfgIdx = 0; # Integer | valid configurations index

my $streamIdx = 0; # Integer | Valid top level descriptor index

my $length = 56; # Integer | data length uncoded
my $data = data_example; # String | 

eval { 
    my $result = $api_instance->writeDescStreamOutput(deviceId => $deviceId, cfgIdx => $cfgIdx, streamIdx => $streamIdx, length => $length, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StreamOutputApi->writeDescStreamOutput: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.StreamOutputApi()
deviceId = 00-50-c2-ff-fe-d4-33-8d # String | Entity device identifier
 (default to null)
cfgIdx = 0 # Integer | valid configurations index
 (default to null)
streamIdx = 0 # Integer | Valid top level descriptor index
 (default to null)
length = 56 # Integer | data length uncoded (default to null)
data = data_example # String |  (default to null)

try: 
    # Write Descriptor in device
    api_response = api_instance.write_desc_stream_output(deviceId, cfgIdx, streamIdx, length, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StreamOutputApi->writeDescStreamOutput: %s\n" % e)
extern crate StreamOutputApi;

pub fn main() {
    let deviceId = 00-50-c2-ff-fe-d4-33-8d; // String
    let cfgIdx = 0; // Integer
    let streamIdx = 0; // Integer
    let length = 56; // Integer
    let data = data_example; // String

    let mut context = StreamOutputApi::Context::default();
    let result = client.writeDescStreamOutput(deviceId, cfgIdx, streamIdx, length, data, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceId*
String
Entity device identifier
Required
cfg_idx*
Integer
valid configurations index
Required
stream_idx*
Integer
Valid top level descriptor index
Required
Form parameters
Name Description
length*
Integer
data length uncoded
Required
data*
String (base64)
Required

Responses