BasicDeviceInformation

aboutGet

Retrieve basic information from your BirdDog device


/about

Usage and SDK Samples

curl -X GET\
-H "Accept: text"\
"http://192.168.2.197:8080/about?FirmwareVersion="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BasicDeviceInformationApi;

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

public class BasicDeviceInformationApiExample {

    public static void main(String[] args) {
        
        BasicDeviceInformationApi apiInstance = new BasicDeviceInformationApi();
        Object firmwareVersion = ; // Object | Device manufactuer `BIRDDOG`
        Object format = ; // Object | Device manufacturer extended `BIRDDOG`
        Object hostName = ; // Object | Hardware Revision `1.0`
        Object iPAddress = ; // Object | Device IP Address `xxx.xxx.xxx.xxx`
        Object networkConfigMethod = ; // Object | IP Address method `DHCP` `STATIC`
        Object serialNumber = ; // Object | Device Hostname (AVAHI) `birddog-nnnnn`
        Object status = ; // Object | Current device status `ONLINE` `OFFLINE` `CAMERA INITIALIZING` `NO VIDEO`
        try {
            apiInstance.aboutGet(firmwareVersion, format, hostName, iPAddress, networkConfigMethod, serialNumber, status);
        } catch (ApiException e) {
            System.err.println("Exception when calling BasicDeviceInformationApi#aboutGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BasicDeviceInformationApi;

public class BasicDeviceInformationApiExample {

    public static void main(String[] args) {
        BasicDeviceInformationApi apiInstance = new BasicDeviceInformationApi();
        Object firmwareVersion = ; // Object | Device manufactuer `BIRDDOG`
        Object format = ; // Object | Device manufacturer extended `BIRDDOG`
        Object hostName = ; // Object | Hardware Revision `1.0`
        Object iPAddress = ; // Object | Device IP Address `xxx.xxx.xxx.xxx`
        Object networkConfigMethod = ; // Object | IP Address method `DHCP` `STATIC`
        Object serialNumber = ; // Object | Device Hostname (AVAHI) `birddog-nnnnn`
        Object status = ; // Object | Current device status `ONLINE` `OFFLINE` `CAMERA INITIALIZING` `NO VIDEO`
        try {
            apiInstance.aboutGet(firmwareVersion, format, hostName, iPAddress, networkConfigMethod, serialNumber, status);
        } catch (ApiException e) {
            System.err.println("Exception when calling BasicDeviceInformationApi#aboutGet");
            e.printStackTrace();
        }
    }
}
Object *firmwareVersion = ; // Device manufactuer `BIRDDOG` (optional)
Object *format = ; // Device manufacturer extended `BIRDDOG` (optional)
Object *hostName = ; // Hardware Revision `1.0` (optional)
Object *iPAddress = ; // Device IP Address `xxx.xxx.xxx.xxx` (optional)
Object *networkConfigMethod = ; // IP Address method `DHCP` `STATIC` (optional)
Object *serialNumber = ; // Device Hostname (AVAHI) `birddog-nnnnn` (optional)
Object *status = ; // Current device status `ONLINE` `OFFLINE` `CAMERA INITIALIZING` `NO VIDEO` (optional)

BasicDeviceInformationApi *apiInstance = [[BasicDeviceInformationApi alloc] init];

// Retrieve basic information from your BirdDog device
[apiInstance aboutGetWith:firmwareVersion
    format:format
    hostName:hostName
    iPAddress:iPAddress
    networkConfigMethod:networkConfigMethod
    serialNumber:serialNumber
    status:status
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
if (this.readyState == 4 && this.status == 200) {
  console.log(this.responseText);
 }
};
xhttp.open("GET", "http://192.168.2.197:8080/about", true);
xhttp.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class aboutGetExample
    {
        public void main()
        {

            var apiInstance = new BasicDeviceInformationApi();
            var firmwareVersion = new Object(); // Object | Device manufactuer `BIRDDOG` (optional) 
            var format = new Object(); // Object | Device manufacturer extended `BIRDDOG` (optional) 
            var hostName = new Object(); // Object | Hardware Revision `1.0` (optional) 
            var iPAddress = new Object(); // Object | Device IP Address `xxx.xxx.xxx.xxx` (optional) 
            var networkConfigMethod = new Object(); // Object | IP Address method `DHCP` `STATIC` (optional) 
            var serialNumber = new Object(); // Object | Device Hostname (AVAHI) `birddog-nnnnn` (optional) 
            var status = new Object(); // Object | Current device status `ONLINE` `OFFLINE` `CAMERA INITIALIZING` `NO VIDEO` (optional) 

            try
            {
                // Retrieve basic information from your BirdDog device
                apiInstance.aboutGet(firmwareVersion, format, hostName, iPAddress, networkConfigMethod, serialNumber, status);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BasicDeviceInformationApi.aboutGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBasicDeviceInformationApi();
$firmwareVersion = ; // Object | Device manufactuer `BIRDDOG`
$format = ; // Object | Device manufacturer extended `BIRDDOG`
$hostName = ; // Object | Hardware Revision `1.0`
$iPAddress = ; // Object | Device IP Address `xxx.xxx.xxx.xxx`
$networkConfigMethod = ; // Object | IP Address method `DHCP` `STATIC`
$serialNumber = ; // Object | Device Hostname (AVAHI) `birddog-nnnnn`
$status = ; // Object | Current device status `ONLINE` `OFFLINE` `CAMERA INITIALIZING` `NO VIDEO`

try {
    $api_instance->aboutGet($firmwareVersion, $format, $hostName, $iPAddress, $networkConfigMethod, $serialNumber, $status);
} catch (Exception $e) {
    echo 'Exception when calling BasicDeviceInformationApi->aboutGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BasicDeviceInformationApi;

my $api_instance = WWW::SwaggerClient::BasicDeviceInformationApi->new();
my $firmwareVersion = ; # Object | Device manufactuer `BIRDDOG`
my $format = ; # Object | Device manufacturer extended `BIRDDOG`
my $hostName = ; # Object | Hardware Revision `1.0`
my $iPAddress = ; # Object | Device IP Address `xxx.xxx.xxx.xxx`
my $networkConfigMethod = ; # Object | IP Address method `DHCP` `STATIC`
my $serialNumber = ; # Object | Device Hostname (AVAHI) `birddog-nnnnn`
my $status = ; # Object | Current device status `ONLINE` `OFFLINE` `CAMERA INITIALIZING` `NO VIDEO`

eval { 
    $api_instance->aboutGet(firmwareVersion => $firmwareVersion, format => $format, hostName => $hostName, iPAddress => $iPAddress, networkConfigMethod => $networkConfigMethod, serialNumber => $serialNumber, status => $status);
};
if ($@) {
    warn "Exception when calling BasicDeviceInformationApi->aboutGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.BasicDeviceInformationApi()
firmwareVersion =  # Object | Device manufactuer `BIRDDOG` (optional)
format =  # Object | Device manufacturer extended `BIRDDOG` (optional)
hostName =  # Object | Hardware Revision `1.0` (optional)
iPAddress =  # Object | Device IP Address `xxx.xxx.xxx.xxx` (optional)
networkConfigMethod =  # Object | IP Address method `DHCP` `STATIC` (optional)
serialNumber =  # Object | Device Hostname (AVAHI) `birddog-nnnnn` (optional)
status =  # Object | Current device status `ONLINE` `OFFLINE` `CAMERA INITIALIZING` `NO VIDEO` (optional)

try: 
    # Retrieve basic information from your BirdDog device
    api_instance.about_get(firmwareVersion=firmwareVersion, format=format, hostName=hostName, iPAddress=iPAddress, networkConfigMethod=networkConfigMethod, serialNumber=serialNumber, status=status)
except ApiException as e:
    print("Exception when calling BasicDeviceInformationApi->aboutGet: %s\n" % e)

Parameters

Header parameters
Name Description
Format
Object (string)
Device manufacturer extended `BIRDDOG`
HostName
Object (string)
Hardware Revision `1.0`
IPAddress
Object (string)
Device IP Address `xxx.xxx.xxx.xxx`
NetworkConfigMethod
Object (string)
IP Address method `DHCP` `STATIC`
SerialNumber
Object (string)
Device Hostname (AVAHI) `birddog-nnnnn`
Status
Object (string)
Current device status `ONLINE` `OFFLINE` `CAMERA INITIALIZING` `NO VIDEO`
Query parameters
Name Description
FirmwareVersion
Object (string)
Device manufactuer `BIRDDOG`

Responses

Status: default - Device standard response

Example data

Content-Type: Example Status response
{"FirmwareVersion":"BirdDog Firmware version","Format":"CAM 1","HostName":"birddog-device","IPAddress":"192.168.100.100","NetworkConfigMethod":"dhcp","NetworkMask":"255.255.255.0","SerialNumber":"0123456789","Status":"active"}

hostnameGet

Retrieve device hostname

This command will return a text string with the host name of the BirdDog device.


/hostname

Usage and SDK Samples

curl -X GET\
-H "Accept: text"\
"http://192.168.2.197:8080/hostname/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BasicDeviceInformationApi;

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

public class BasicDeviceInformationApiExample {

    public static void main(String[] args) {
        
        BasicDeviceInformationApi apiInstance = new BasicDeviceInformationApi();
        try {
            apiInstance.hostnameGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling BasicDeviceInformationApi#hostnameGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BasicDeviceInformationApi;

public class BasicDeviceInformationApiExample {

    public static void main(String[] args) {
        BasicDeviceInformationApi apiInstance = new BasicDeviceInformationApi();
        try {
            apiInstance.hostnameGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling BasicDeviceInformationApi#hostnameGet");
            e.printStackTrace();
        }
    }
}

BasicDeviceInformationApi *apiInstance = [[BasicDeviceInformationApi alloc] init];

// Retrieve device hostname
[apiInstance hostnameGetWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
if (this.readyState == 4 && this.status == 200) {
  console.log(this.responseText);
 }
};
xhttp.open("GET", "http://192.168.2.197:8080/hostname", true);
xhttp.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class hostnameGetExample
    {
        public void main()
        {

            var apiInstance = new BasicDeviceInformationApi();

            try
            {
                // Retrieve device hostname
                apiInstance.hostnameGet();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BasicDeviceInformationApi.hostnameGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBasicDeviceInformationApi();

try {
    $api_instance->hostnameGet();
} catch (Exception $e) {
    echo 'Exception when calling BasicDeviceInformationApi->hostnameGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BasicDeviceInformationApi;

my $api_instance = WWW::SwaggerClient::BasicDeviceInformationApi->new();

eval { 
    $api_instance->hostnameGet();
};
if ($@) {
    warn "Exception when calling BasicDeviceInformationApi->hostnameGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.BasicDeviceInformationApi()

try: 
    # Retrieve device hostname
    api_instance.hostname_get()
except ApiException as e:
    print("Exception when calling BasicDeviceInformationApi->hostnameGet: %s\n" % e)

Parameters

Responses

Status: default - Device hostname (NDI Hostname)

Example data

Content-Type: Example Status response
birddog-nnnnn

rebootGet

Reboot BirdDog device

This command will immediately initiate a reboot of the BirdDog device.


/reboot

Usage and SDK Samples

curl -X GET\
-H "Accept: text"\
"http://192.168.2.197:8080/reboot"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BasicDeviceInformationApi;

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

public class BasicDeviceInformationApiExample {

    public static void main(String[] args) {
        
        BasicDeviceInformationApi apiInstance = new BasicDeviceInformationApi();
        try {
            apiInstance.rebootGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling BasicDeviceInformationApi#rebootGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BasicDeviceInformationApi;

public class BasicDeviceInformationApiExample {

    public static void main(String[] args) {
        BasicDeviceInformationApi apiInstance = new BasicDeviceInformationApi();
        try {
            apiInstance.rebootGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling BasicDeviceInformationApi#rebootGet");
            e.printStackTrace();
        }
    }
}

BasicDeviceInformationApi *apiInstance = [[BasicDeviceInformationApi alloc] init];

// Reboot BirdDog device
[apiInstance rebootGetWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
if (this.readyState == 4 && this.status == 200) {
  console.log(this.responseText);
 }
};
xhttp.open("GET", "http://192.168.2.197:8080/reboot", true);
xhttp.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class rebootGetExample
    {
        public void main()
        {

            var apiInstance = new BasicDeviceInformationApi();

            try
            {
                // Reboot BirdDog device
                apiInstance.rebootGet();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BasicDeviceInformationApi.rebootGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBasicDeviceInformationApi();

try {
    $api_instance->rebootGet();
} catch (Exception $e) {
    echo 'Exception when calling BasicDeviceInformationApi->rebootGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BasicDeviceInformationApi;

my $api_instance = WWW::SwaggerClient::BasicDeviceInformationApi->new();

eval { 
    $api_instance->rebootGet();
};
if ($@) {
    warn "Exception when calling BasicDeviceInformationApi->rebootGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.BasicDeviceInformationApi()

try: 
    # Reboot BirdDog device
    api_instance.reboot_get()
except ApiException as e:
    print("Exception when calling BasicDeviceInformationApi->rebootGet: %s\n" % e)

Parameters

Responses

Status: default - Immediately upon device reboot, the below value will be returned

Example data

Content-Type: Example Status response
{}

rebootPost

Reboot BirdDog device

This command will immediately initiate a reboot of the BirdDog device.


/reboot

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"http://192.168.2.197:8080/reboot"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BasicDeviceInformationApi;

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

public class BasicDeviceInformationApiExample {

    public static void main(String[] args) {
        
        BasicDeviceInformationApi apiInstance = new BasicDeviceInformationApi();
        try {
            apiInstance.rebootPost();
        } catch (ApiException e) {
            System.err.println("Exception when calling BasicDeviceInformationApi#rebootPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BasicDeviceInformationApi;

public class BasicDeviceInformationApiExample {

    public static void main(String[] args) {
        BasicDeviceInformationApi apiInstance = new BasicDeviceInformationApi();
        try {
            apiInstance.rebootPost();
        } catch (ApiException e) {
            System.err.println("Exception when calling BasicDeviceInformationApi#rebootPost");
            e.printStackTrace();
        }
    }
}

BasicDeviceInformationApi *apiInstance = [[BasicDeviceInformationApi alloc] init];

// Reboot BirdDog device
[apiInstance rebootPostWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhr = new XMLHttpRequest();
xhr.open("POST", "http://192.168.2.197:8080/reboot", true);
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class rebootPostExample
    {
        public void main()
        {

            var apiInstance = new BasicDeviceInformationApi();

            try
            {
                // Reboot BirdDog device
                apiInstance.rebootPost();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BasicDeviceInformationApi.rebootPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBasicDeviceInformationApi();

try {
    $api_instance->rebootPost();
} catch (Exception $e) {
    echo 'Exception when calling BasicDeviceInformationApi->rebootPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BasicDeviceInformationApi;

my $api_instance = WWW::SwaggerClient::BasicDeviceInformationApi->new();

eval { 
    $api_instance->rebootPost();
};
if ($@) {
    warn "Exception when calling BasicDeviceInformationApi->rebootPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.BasicDeviceInformationApi()

try: 
    # Reboot BirdDog device
    api_instance.reboot_post()
except ApiException as e:
    print("Exception when calling BasicDeviceInformationApi->rebootPost: %s\n" % e)

Parameters

Responses

Status: default - Immediately upon device reboot, the below value will be returned

Example data

Content-Type: Example Status response
{}

restartGet

Restart video subsystem on device

This command will initiate a video system restart on the BirdDog device.


/restart

Usage and SDK Samples

curl -X GET\
-H "Accept: text"\
"http://192.168.2.197:8080/restart"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BasicDeviceInformationApi;

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

public class BasicDeviceInformationApiExample {

    public static void main(String[] args) {
        
        BasicDeviceInformationApi apiInstance = new BasicDeviceInformationApi();
        try {
            apiInstance.restartGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling BasicDeviceInformationApi#restartGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BasicDeviceInformationApi;

public class BasicDeviceInformationApiExample {

    public static void main(String[] args) {
        BasicDeviceInformationApi apiInstance = new BasicDeviceInformationApi();
        try {
            apiInstance.restartGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling BasicDeviceInformationApi#restartGet");
            e.printStackTrace();
        }
    }
}

BasicDeviceInformationApi *apiInstance = [[BasicDeviceInformationApi alloc] init];

// Restart video subsystem on device
[apiInstance restartGetWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
if (this.readyState == 4 && this.status == 200) {
  console.log(this.responseText);
 }
};
xhttp.open("GET", "http://192.168.2.197:8080/restart", true);
xhttp.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class restartGetExample
    {
        public void main()
        {

            var apiInstance = new BasicDeviceInformationApi();

            try
            {
                // Restart video subsystem on device
                apiInstance.restartGet();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BasicDeviceInformationApi.restartGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBasicDeviceInformationApi();

try {
    $api_instance->restartGet();
} catch (Exception $e) {
    echo 'Exception when calling BasicDeviceInformationApi->restartGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BasicDeviceInformationApi;

my $api_instance = WWW::SwaggerClient::BasicDeviceInformationApi->new();

eval { 
    $api_instance->restartGet();
};
if ($@) {
    warn "Exception when calling BasicDeviceInformationApi->restartGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.BasicDeviceInformationApi()

try: 
    # Restart video subsystem on device
    api_instance.restart_get()
except ApiException as e:
    print("Exception when calling BasicDeviceInformationApi->restartGet: %s\n" % e)

Parameters

Responses

Status: default - Immediately upon restart video, the below value will be returned

Example data

Content-Type: Example Status response
{}

restartPost

Restart video subsystem on device

This command will initiate a video system restart on the BirdDog device.


/restart

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"http://192.168.2.197:8080/restart"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BasicDeviceInformationApi;

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

public class BasicDeviceInformationApiExample {

    public static void main(String[] args) {
        
        BasicDeviceInformationApi apiInstance = new BasicDeviceInformationApi();
        try {
            apiInstance.restartPost();
        } catch (ApiException e) {
            System.err.println("Exception when calling BasicDeviceInformationApi#restartPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BasicDeviceInformationApi;

public class BasicDeviceInformationApiExample {

    public static void main(String[] args) {
        BasicDeviceInformationApi apiInstance = new BasicDeviceInformationApi();
        try {
            apiInstance.restartPost();
        } catch (ApiException e) {
            System.err.println("Exception when calling BasicDeviceInformationApi#restartPost");
            e.printStackTrace();
        }
    }
}

BasicDeviceInformationApi *apiInstance = [[BasicDeviceInformationApi alloc] init];

// Restart video subsystem on device
[apiInstance restartPostWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhr = new XMLHttpRequest();
xhr.open("POST", "http://192.168.2.197:8080/restart", true);
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class restartPostExample
    {
        public void main()
        {

            var apiInstance = new BasicDeviceInformationApi();

            try
            {
                // Restart video subsystem on device
                apiInstance.restartPost();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BasicDeviceInformationApi.restartPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBasicDeviceInformationApi();

try {
    $api_instance->restartPost();
} catch (Exception $e) {
    echo 'Exception when calling BasicDeviceInformationApi->restartPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BasicDeviceInformationApi;

my $api_instance = WWW::SwaggerClient::BasicDeviceInformationApi->new();

eval { 
    $api_instance->restartPost();
};
if ($@) {
    warn "Exception when calling BasicDeviceInformationApi->restartPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.BasicDeviceInformationApi()

try: 
    # Restart video subsystem on device
    api_instance.restart_post()
except ApiException as e:
    print("Exception when calling BasicDeviceInformationApi->restartPost: %s\n" % e)

Parameters

Responses

Status: default - Immediately upon restart video, the below value will be returned

Example data

Content-Type: Example Status response
{}

versionGet

Hardware version number query

This command will recall the BirdDog hardware identifier, this includes the model number as well as the hardware version.


/version

Usage and SDK Samples

curl -X GET\
-H "Accept: text"\
"http://192.168.2.197:8080/version"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BasicDeviceInformationApi;

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

public class BasicDeviceInformationApiExample {

    public static void main(String[] args) {
        
        BasicDeviceInformationApi apiInstance = new BasicDeviceInformationApi();
        try {
            apiInstance.versionGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling BasicDeviceInformationApi#versionGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BasicDeviceInformationApi;

public class BasicDeviceInformationApiExample {

    public static void main(String[] args) {
        BasicDeviceInformationApi apiInstance = new BasicDeviceInformationApi();
        try {
            apiInstance.versionGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling BasicDeviceInformationApi#versionGet");
            e.printStackTrace();
        }
    }
}

BasicDeviceInformationApi *apiInstance = [[BasicDeviceInformationApi alloc] init];

// Hardware version number query
[apiInstance versionGetWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
if (this.readyState == 4 && this.status == 200) {
  console.log(this.responseText);
 }
};
xhttp.open("GET", "http://192.168.2.197:8080/version", true);
xhttp.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class versionGetExample
    {
        public void main()
        {

            var apiInstance = new BasicDeviceInformationApi();

            try
            {
                // Hardware version number query
                apiInstance.versionGet();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BasicDeviceInformationApi.versionGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBasicDeviceInformationApi();

try {
    $api_instance->versionGet();
} catch (Exception $e) {
    echo 'Exception when calling BasicDeviceInformationApi->versionGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BasicDeviceInformationApi;

my $api_instance = WWW::SwaggerClient::BasicDeviceInformationApi->new();

eval { 
    $api_instance->versionGet();
};
if ($@) {
    warn "Exception when calling BasicDeviceInformationApi->versionGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.BasicDeviceInformationApi()

try: 
    # Hardware version number query
    api_instance.version_get()
except ApiException as e:
    print("Exception when calling BasicDeviceInformationApi->versionGet: %s\n" % e)

Parameters

Responses

Status: default - Device standard response

Example data

Content-Type: Example Status response
BirdDog P200A4_A5

DEVICESETTINGS

analogaudiosetupGet

Retrieve Audio Settings

AnalogAudiooutputselect is not present in Flex Encode, WP Encode, QUAD, P200/A200/A300, P100/PF120 and P4k/P400


/analogaudiosetup

Usage and SDK Samples

curl -X GET\
-H "Accept: text"\
"http://192.168.2.197:8080/analogaudiosetup?AnalogAudioInGain=&AnalogAudioOutGain=&AnalogAudiooutputselect="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DEVICESETTINGSApi;

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

public class DEVICESETTINGSApiExample {

    public static void main(String[] args) {
        
        DEVICESETTINGSApi apiInstance = new DEVICESETTINGSApi();
        Object analogAudioInGain = ; // Object | Audio in gain Range 0 to 100
        Object analogAudioOutGain = ; // Object | Audio out gain Range 0 to 100
        Object analogAudiooutputselect = ; // Object | DecodeMain, DecodeComms, DecodeLoop
        try {
            apiInstance.analogaudiosetupGet(analogAudioInGain, analogAudioOutGain, analogAudiooutputselect);
        } catch (ApiException e) {
            System.err.println("Exception when calling DEVICESETTINGSApi#analogaudiosetupGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DEVICESETTINGSApi;

public class DEVICESETTINGSApiExample {

    public static void main(String[] args) {
        DEVICESETTINGSApi apiInstance = new DEVICESETTINGSApi();
        Object analogAudioInGain = ; // Object | Audio in gain Range 0 to 100
        Object analogAudioOutGain = ; // Object | Audio out gain Range 0 to 100
        Object analogAudiooutputselect = ; // Object | DecodeMain, DecodeComms, DecodeLoop
        try {
            apiInstance.analogaudiosetupGet(analogAudioInGain, analogAudioOutGain, analogAudiooutputselect);
        } catch (ApiException e) {
            System.err.println("Exception when calling DEVICESETTINGSApi#analogaudiosetupGet");
            e.printStackTrace();
        }
    }
}
Object *analogAudioInGain = ; // Audio in gain Range 0 to 100 (optional)
Object *analogAudioOutGain = ; // Audio out gain Range 0 to 100 (optional)
Object *analogAudiooutputselect = ; // DecodeMain, DecodeComms, DecodeLoop (optional)

DEVICESETTINGSApi *apiInstance = [[DEVICESETTINGSApi alloc] init];

// Retrieve Audio Settings
[apiInstance analogaudiosetupGetWith:analogAudioInGain
    analogAudioOutGain:analogAudioOutGain
    analogAudiooutputselect:analogAudiooutputselect
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
if (this.readyState == 4 && this.status == 200) {
  console.log(this.responseText);
 }
};
xhttp.open("GET", "http://192.168.2.197:8080/analogaudiosetup", true);
xhttp.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class analogaudiosetupGetExample
    {
        public void main()
        {

            var apiInstance = new DEVICESETTINGSApi();
            var analogAudioInGain = new Object(); // Object | Audio in gain Range 0 to 100 (optional) 
            var analogAudioOutGain = new Object(); // Object | Audio out gain Range 0 to 100 (optional) 
            var analogAudiooutputselect = new Object(); // Object | DecodeMain, DecodeComms, DecodeLoop (optional) 

            try
            {
                // Retrieve Audio Settings
                apiInstance.analogaudiosetupGet(analogAudioInGain, analogAudioOutGain, analogAudiooutputselect);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DEVICESETTINGSApi.analogaudiosetupGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDEVICESETTINGSApi();
$analogAudioInGain = ; // Object | Audio in gain Range 0 to 100
$analogAudioOutGain = ; // Object | Audio out gain Range 0 to 100
$analogAudiooutputselect = ; // Object | DecodeMain, DecodeComms, DecodeLoop

try {
    $api_instance->analogaudiosetupGet($analogAudioInGain, $analogAudioOutGain, $analogAudiooutputselect);
} catch (Exception $e) {
    echo 'Exception when calling DEVICESETTINGSApi->analogaudiosetupGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DEVICESETTINGSApi;

my $api_instance = WWW::SwaggerClient::DEVICESETTINGSApi->new();
my $analogAudioInGain = ; # Object | Audio in gain Range 0 to 100
my $analogAudioOutGain = ; # Object | Audio out gain Range 0 to 100
my $analogAudiooutputselect = ; # Object | DecodeMain, DecodeComms, DecodeLoop

eval { 
    $api_instance->analogaudiosetupGet(analogAudioInGain => $analogAudioInGain, analogAudioOutGain => $analogAudioOutGain, analogAudiooutputselect => $analogAudiooutputselect);
};
if ($@) {
    warn "Exception when calling DEVICESETTINGSApi->analogaudiosetupGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DEVICESETTINGSApi()
analogAudioInGain =  # Object | Audio in gain Range 0 to 100 (optional)
analogAudioOutGain =  # Object | Audio out gain Range 0 to 100 (optional)
analogAudiooutputselect =  # Object | DecodeMain, DecodeComms, DecodeLoop (optional)

try: 
    # Retrieve Audio Settings
    api_instance.analogaudiosetup_get(analogAudioInGain=analogAudioInGain, analogAudioOutGain=analogAudioOutGain, analogAudiooutputselect=analogAudiooutputselect)
except ApiException as e:
    print("Exception when calling DEVICESETTINGSApi->analogaudiosetupGet: %s\n" % e)

Parameters

Query parameters
Name Description
AnalogAudioInGain
Object (string)
Audio in gain Range 0 to 100
AnalogAudioOutGain
Object (string)
Audio out gain Range 0 to 100
AnalogAudiooutputselect
Object (string)
DecodeMain, DecodeComms, DecodeLoop

Responses

Status: default - Device standard response

Example data

Content-Type: Example Status response
{"AnalogAudioInGain":"80","AnalogAudioOutGain":"80","AnalogAudiooutputselect":"DecodeMain"}

analogaudiosetupPost

Set Audio Settings

AnalogAudiooutputselect is not present in Flex Encode, WP Encode, QUAD, P200/A200/A300, P100/PF120 and P4k/P400


/analogaudiosetup

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json"\
-d {\"AnalogAudioInGain\":\"50\",\"AnalogAudioOutGain\":\"50\",\"AnalogAudiooutputselect\":\"DecodeMain\"} http://192.168.2.197:8080/analogaudiosetup
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DEVICESETTINGSApi;

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

public class DEVICESETTINGSApiExample {

    public static void main(String[] args) {
        
        DEVICESETTINGSApi apiInstance = new DEVICESETTINGSApi();
        Object analogAudioInGain = ; // Object | Audio in gain Range 0 to 100
        Object analogAudioOutGain = ; // Object | Audio out gain Range 0 to 100
        Object analogAudiooutputselect = ; // Object | DecodeMain, DecodeComms, DecodeLoop
        try {
            apiInstance.analogaudiosetupPost(analogAudioInGain, analogAudioOutGain, analogAudiooutputselect);
        } catch (ApiException e) {
            System.err.println("Exception when calling DEVICESETTINGSApi#analogaudiosetupPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DEVICESETTINGSApi;

public class DEVICESETTINGSApiExample {

    public static void main(String[] args) {
        DEVICESETTINGSApi apiInstance = new DEVICESETTINGSApi();
        Object analogAudioInGain = ; // Object | Audio in gain Range 0 to 100
        Object analogAudioOutGain = ; // Object | Audio out gain Range 0 to 100
        Object analogAudiooutputselect = ; // Object | DecodeMain, DecodeComms, DecodeLoop
        try {
            apiInstance.analogaudiosetupPost(analogAudioInGain, analogAudioOutGain, analogAudiooutputselect);
        } catch (ApiException e) {
            System.err.println("Exception when calling DEVICESETTINGSApi#analogaudiosetupPost");
            e.printStackTrace();
        }
    }
}
Object *analogAudioInGain = ; // Audio in gain Range 0 to 100 (optional)
Object *analogAudioOutGain = ; // Audio out gain Range 0 to 100 (optional)
Object *analogAudiooutputselect = ; // DecodeMain, DecodeComms, DecodeLoop (optional)

DEVICESETTINGSApi *apiInstance = [[DEVICESETTINGSApi alloc] init];

// Set Audio Settings
[apiInstance analogaudiosetupPostWith:analogAudioInGain
    analogAudioOutGain:analogAudioOutGain
    analogAudiooutputselect:analogAudiooutputselect
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhr = new XMLHttpRequest();
var url = "http://192.168.2.197:8080/analogaudiosetup";
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/json");
xhr.onreadystatechange = function () {
    if (xhr.readyState === 4 && xhr.status === 200) {
	  console.log(xhr.responseText);
    }
};
var data = JSON.stringify({"AnalogAudioInGain":"20","AnalogAudioOutGain":"35","AnalogAudiooutputselect":"DecodeMain"});
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class analogaudiosetupPostExample
    {
        public void main()
        {

            var apiInstance = new DEVICESETTINGSApi();
            var analogAudioInGain = new Object(); // Object | Audio in gain Range 0 to 100 (optional) 
            var analogAudioOutGain = new Object(); // Object | Audio out gain Range 0 to 100 (optional) 
            var analogAudiooutputselect = new Object(); // Object | DecodeMain, DecodeComms, DecodeLoop (optional) 

            try
            {
                // Set Audio Settings
                apiInstance.analogaudiosetupPost(analogAudioInGain, analogAudioOutGain, analogAudiooutputselect);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DEVICESETTINGSApi.analogaudiosetupPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDEVICESETTINGSApi();
$analogAudioInGain = ; // Object | Audio in gain Range 0 to 100
$analogAudioOutGain = ; // Object | Audio out gain Range 0 to 100
$analogAudiooutputselect = ; // Object | DecodeMain, DecodeComms, DecodeLoop

try {
    $api_instance->analogaudiosetupPost($analogAudioInGain, $analogAudioOutGain, $analogAudiooutputselect);
} catch (Exception $e) {
    echo 'Exception when calling DEVICESETTINGSApi->analogaudiosetupPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DEVICESETTINGSApi;

my $api_instance = WWW::SwaggerClient::DEVICESETTINGSApi->new();
my $analogAudioInGain = ; # Object | Audio in gain Range 0 to 100
my $analogAudioOutGain = ; # Object | Audio out gain Range 0 to 100
my $analogAudiooutputselect = ; # Object | DecodeMain, DecodeComms, DecodeLoop

eval { 
    $api_instance->analogaudiosetupPost(analogAudioInGain => $analogAudioInGain, analogAudioOutGain => $analogAudioOutGain, analogAudiooutputselect => $analogAudiooutputselect);
};
if ($@) {
    warn "Exception when calling DEVICESETTINGSApi->analogaudiosetupPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DEVICESETTINGSApi()
analogAudioInGain =  # Object | Audio in gain Range 0 to 100 (optional)
analogAudioOutGain =  # Object | Audio out gain Range 0 to 100 (optional)
analogAudiooutputselect =  # Object | DecodeMain, DecodeComms, DecodeLoop (optional)

try: 
    # Set Audio Settings
    api_instance.analogaudiosetup_post(analogAudioInGain=analogAudioInGain, analogAudioOutGain=analogAudioOutGain, analogAudiooutputselect=analogAudiooutputselect)
except ApiException as e:
    print("Exception when calling DEVICESETTINGSApi->analogaudiosetupPost: %s\n" % e)

Parameters

Query parameters
Name Description
AnalogAudioInGain
Object (string)
Audio in gain Range 0 to 100
AnalogAudioOutGain
Object (string)
Audio out gain Range 0 to 100
AnalogAudiooutputselect
Object (string)
DecodeMain, DecodeComms, DecodeLoop

Responses

Status: default - Device standard response

Example data

Content-Type: Example Status response
{"AnalogAudioInGain":"80","AnalogAudioOutGain":"80","AnalogAudiooutputselect":"DecodeMain"}

operationmodeGet

Retrieve current operaiton mode of your BirdDog device (encode/decode)

This shows you what mode your BirdDog device is operating in - NDI(R) encode or NDI(R) decode.

Operation Mode is not present in Flex Encode, Flex Decode, WP Encode, WP Decode, P200/A200/A300, P100/PF120, P4k/P400


/operationmode

Usage and SDK Samples

curl -X GET\
  -H "Accept: text"\
  "http://192.168.2.197:8080/operationmode"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DEVICESETTINGSApi;

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

public class DEVICESETTINGSApiExample {

    public static void main(String[] args) {
        
        DEVICESETTINGSApi apiInstance = new DEVICESETTINGSApi();
        Object mode = ; // Object | Device operation mode `encode` `decode`
        try {
            apiInstance.operationmodeGet(mode);
        } catch (ApiException e) {
            System.err.println("Exception when calling DEVICESETTINGSApi#operationmodeGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DEVICESETTINGSApi;

public class DEVICESETTINGSApiExample {

    public static void main(String[] args) {
        DEVICESETTINGSApi apiInstance = new DEVICESETTINGSApi();
        Object mode = ; // Object | Device operation mode `encode` `decode`
        try {
            apiInstance.operationmodeGet(mode);
        } catch (ApiException e) {
            System.err.println("Exception when calling DEVICESETTINGSApi#operationmodeGet");
            e.printStackTrace();
        }
    }
}
Object *mode = ; // Device operation mode `encode` `decode` (optional)

DEVICESETTINGSApi *apiInstance = [[DEVICESETTINGSApi alloc] init];

// Retrieve current operaiton mode of your BirdDog device (encode/decode)
[apiInstance operationmodeGetWith:mode
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
if (this.readyState == 4 && this.status == 200) {
  console.log(this.responseText);
 }
};
xhttp.open("GET", "http://192.168.2.197:8080/operationmode", true);
xhttp.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class operationmodeGetExample
    {
        public void main()
        {

            var apiInstance = new DEVICESETTINGSApi();
            var mode = new Object(); // Object | Device operation mode `encode` `decode` (optional) 

            try
            {
                // Retrieve current operaiton mode of your BirdDog device (encode/decode)
                apiInstance.operationmodeGet(mode);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DEVICESETTINGSApi.operationmodeGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDEVICESETTINGSApi();
$mode = ; // Object | Device operation mode `encode` `decode`

try {
    $api_instance->operationmodeGet($mode);
} catch (Exception $e) {
    echo 'Exception when calling DEVICESETTINGSApi->operationmodeGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DEVICESETTINGSApi;

my $api_instance = WWW::SwaggerClient::DEVICESETTINGSApi->new();
my $mode = ; # Object | Device operation mode `encode` `decode`

eval { 
    $api_instance->operationmodeGet(mode => $mode);
};
if ($@) {
    warn "Exception when calling DEVICESETTINGSApi->operationmodeGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DEVICESETTINGSApi()
mode =  # Object | Device operation mode `encode` `decode` (optional)

try: 
    # Retrieve current operaiton mode of your BirdDog device (encode/decode)
    api_instance.operationmode_get(mode=mode)
except ApiException as e:
    print("Exception when calling DEVICESETTINGSApi->operationmodeGet: %s\n" % e)

Parameters

Header parameters
Name Description
mode
Object (string)
Device operation mode `encode` `decode`

Responses

Status: default - Current device operation mode is displayed

Example data

Content-Type: Example Status response
encode

operationmodePost

Set base operation modes of your BirdDog device

This command allows you to switch between NDI(R) encode and NDI(R) decode mode on the device - if supported.

Operation Mode is not present in Flex Encode, Flex Decode, WP Encode, WP Decode, P200/A200/A300, P100/PF120, P4k/P400


/operationmode

Usage and SDK Samples

curl -X POST\
-H "Content-Type: text/plain"\
-d decode http://192.168.2.197:8080/operationmode
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DEVICESETTINGSApi;

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

public class DEVICESETTINGSApiExample {

    public static void main(String[] args) {
        
        DEVICESETTINGSApi apiInstance = new DEVICESETTINGSApi();
        Object mode = ; // Object | Device operation mode `encode` `decode`
        try {
            apiInstance.operationmodePost(mode);
        } catch (ApiException e) {
            System.err.println("Exception when calling DEVICESETTINGSApi#operationmodePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DEVICESETTINGSApi;

public class DEVICESETTINGSApiExample {

    public static void main(String[] args) {
        DEVICESETTINGSApi apiInstance = new DEVICESETTINGSApi();
        Object mode = ; // Object | Device operation mode `encode` `decode`
        try {
            apiInstance.operationmodePost(mode);
        } catch (ApiException e) {
            System.err.println("Exception when calling DEVICESETTINGSApi#operationmodePost");
            e.printStackTrace();
        }
    }
}
Object *mode = ; // Device operation mode `encode` `decode` (optional)

DEVICESETTINGSApi *apiInstance = [[DEVICESETTINGSApi alloc] init];

// Set base operation modes of your BirdDog device
[apiInstance operationmodePostWith:mode
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhr = new XMLHttpRequest();
var url = "http://192.168.2.197:8080/operationmode";
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "text/plain");
xhr.onreadystatechange = function () {
    if (xhr.readyState === 4 && xhr.status === 200) {
	  console.log(xhr.responseText);
    }
};
var data = "encode";
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class operationmodePostExample
    {
        public void main()
        {

            var apiInstance = new DEVICESETTINGSApi();
            var mode = new Object(); // Object | Device operation mode `encode` `decode` (optional) 

            try
            {
                // Set base operation modes of your BirdDog device
                apiInstance.operationmodePost(mode);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DEVICESETTINGSApi.operationmodePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDEVICESETTINGSApi();
$mode = ; // Object | Device operation mode `encode` `decode`

try {
    $api_instance->operationmodePost($mode);
} catch (Exception $e) {
    echo 'Exception when calling DEVICESETTINGSApi->operationmodePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DEVICESETTINGSApi;

my $api_instance = WWW::SwaggerClient::DEVICESETTINGSApi->new();
my $mode = ; # Object | Device operation mode `encode` `decode`

eval { 
    $api_instance->operationmodePost(mode => $mode);
};
if ($@) {
    warn "Exception when calling DEVICESETTINGSApi->operationmodePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DEVICESETTINGSApi()
mode =  # Object | Device operation mode `encode` `decode` (optional)

try: 
    # Set base operation modes of your BirdDog device
    api_instance.operationmode_post(mode=mode)
except ApiException as e:
    print("Exception when calling DEVICESETTINGSApi->operationmodePost: %s\n" % e)

Parameters

Header parameters
Name Description
mode
Object (string)
Device operation mode `encode` `decode`

Responses

Status: default - Once accepted, the API will return confirmation of the new mode set

Example data

Content-Type: Example Status response
encode

videooutputinterfaceGet

Retrieve current videooutputinterface mode of your BirdDog device (sdi/hdmi) or (LowLatency/NormalMode)

This shows you what mode your BirdDog device videooutputinterface is (sdi/hdmi) or (LowLatency/NormalMode)

videooutputinterface Mode is not present in Studio, Mini, Flex Encode, Flex Decode, WP Encode, WP Decode, QUAD, P200/A200/A300, P100/PF120, P4k/P400


/videooutputinterface

Usage and SDK Samples

curl -X GET\
-H "Accept: text"\
"http://192.168.2.197:8080/videooutputinterface"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DEVICESETTINGSApi;

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

public class DEVICESETTINGSApiExample {

    public static void main(String[] args) {
        
        DEVICESETTINGSApi apiInstance = new DEVICESETTINGSApi();
        Object videooutput = ; // Object | Device operation mode `sdi` `hdmi` `LowLatency` `NormalMode`
        try {
            apiInstance.videooutputinterfaceGet(videooutput);
        } catch (ApiException e) {
            System.err.println("Exception when calling DEVICESETTINGSApi#videooutputinterfaceGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DEVICESETTINGSApi;

public class DEVICESETTINGSApiExample {

    public static void main(String[] args) {
        DEVICESETTINGSApi apiInstance = new DEVICESETTINGSApi();
        Object videooutput = ; // Object | Device operation mode `sdi` `hdmi` `LowLatency` `NormalMode`
        try {
            apiInstance.videooutputinterfaceGet(videooutput);
        } catch (ApiException e) {
            System.err.println("Exception when calling DEVICESETTINGSApi#videooutputinterfaceGet");
            e.printStackTrace();
        }
    }
}
Object *videooutput = ; // Device operation mode `sdi` `hdmi` `LowLatency` `NormalMode` (optional)

DEVICESETTINGSApi *apiInstance = [[DEVICESETTINGSApi alloc] init];

// Retrieve current operaiton mode of your BirdDog device (encode/decode)
[apiInstance videooutputinterfaceGetWith:videooutput
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
if (this.readyState == 4 && this.status == 200) {
  console.log(this.responseText);
 }
};
xhttp.open("GET", "http://192.168.2.197:8080/videooutputinterface", true);
xhttp.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class videooutputinterfaceGetExample
    {
        public void main()
        {

            var apiInstance = new DEVICESETTINGSApi();
            var videooutput = new Object(); // Object | Device operation mode `sdi` `hdmi` `LowLatency` `NormalMode` (optional) 

            try
            {
                // Retrieve current operaiton mode of your BirdDog device (encode/decode)
                apiInstance.videooutputinterfaceGet(videooutput);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DEVICESETTINGSApi.videooutputinterfaceGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDEVICESETTINGSApi();
$videooutput = ; // Object | Device operation mode `sdi` `hdmi` `LowLatency` `NormalMode`

try {
    $api_instance->videooutputinterfaceGet($videooutput);
} catch (Exception $e) {
    echo 'Exception when calling DEVICESETTINGSApi->videooutputinterfaceGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DEVICESETTINGSApi;

my $api_instance = WWW::SwaggerClient::DEVICESETTINGSApi->new();
my $videooutput = ; # Object | Device operation mode `sdi` `hdmi` `LowLatency` `NormalMode`

eval { 
    $api_instance->videooutputinterfaceGet(videooutput => $videooutput);
};
if ($@) {
    warn "Exception when calling DEVICESETTINGSApi->videooutputinterfaceGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DEVICESETTINGSApi()
videooutput =  # Object | Device operation mode `sdi` `hdmi` `LowLatency` `NormalMode` (optional)

try: 
    # Retrieve current operaiton mode of your BirdDog device (encode/decode)
    api_instance.videooutputinterface_get(videooutput=videooutput)
except ApiException as e:
    print("Exception when calling DEVICESETTINGSApi->videooutputinterfaceGet: %s\n" % e)

Parameters

Header parameters
Name Description
videooutput
Object (string)
Device operation mode `sdi` `hdmi` `LowLatency` `NormalMode`

Responses

Status: default - Current device operation mode is displayed

Example data

Content-Type: Example Status response
NormalMode

videooutputinterfacePost

Set base videooutputinterface mode of your BirdDog device

This command allows you to switch between sdi/hdmi) or (LowLatency/NormalMode) on the device - if supported.

videooutputinterface Mode is not present in Studio, Mini, Flex Encode, Flex Decode, WP Encode, WP Decode, QUAD, P200/A200/A300, P100/PF120, P4k/P400


/videooutputinterface

Usage and SDK Samples

curl -X POST\
-H "Content-Type: text/plain"\
-d NormalMode http://192.168.2.197:8080/videooutputinterface
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DEVICESETTINGSApi;

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

public class DEVICESETTINGSApiExample {

    public static void main(String[] args) {
        
        DEVICESETTINGSApi apiInstance = new DEVICESETTINGSApi();
        Object videooutput = ; // Object | Device operation mode `sdi` `hdmi` `LowLatency` `NormalMode`
        try {
            apiInstance.videooutputinterfacePost(videooutput);
        } catch (ApiException e) {
            System.err.println("Exception when calling DEVICESETTINGSApi#videooutputinterfacePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DEVICESETTINGSApi;

public class DEVICESETTINGSApiExample {

    public static void main(String[] args) {
        DEVICESETTINGSApi apiInstance = new DEVICESETTINGSApi();
        Object videooutput = ; // Object | Device operation mode `sdi` `hdmi` `LowLatency` `NormalMode`
        try {
            apiInstance.videooutputinterfacePost(videooutput);
        } catch (ApiException e) {
            System.err.println("Exception when calling DEVICESETTINGSApi#videooutputinterfacePost");
            e.printStackTrace();
        }
    }
}
Object *videooutput = ; // Device operation mode `sdi` `hdmi` `LowLatency` `NormalMode` (optional)

DEVICESETTINGSApi *apiInstance = [[DEVICESETTINGSApi alloc] init];

// Set base operation modes of your BirdDog device
[apiInstance videooutputinterfacePostWith:videooutput
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhr = new XMLHttpRequest();
var url = "http://192.168.2.197:8080/videooutputinterface";
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "text/plain");
xhr.onreadystatechange = function () {
    if (xhr.readyState === 4 && xhr.status === 200) {
	  console.log(xhr.responseText);
    }
};
var data = "NormalMode";
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class videooutputinterfacePostExample
    {
        public void main()
        {

            var apiInstance = new DEVICESETTINGSApi();
            var videooutput = new Object(); // Object | Device operation mode `sdi` `hdmi` `LowLatency` `NormalMode` (optional) 

            try
            {
                // Set base operation modes of your BirdDog device
                apiInstance.videooutputinterfacePost(videooutput);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DEVICESETTINGSApi.videooutputinterfacePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDEVICESETTINGSApi();
$videooutput = ; // Object | Device operation mode `sdi` `hdmi` `LowLatency` `NormalMode`

try {
    $api_instance->videooutputinterfacePost($videooutput);
} catch (Exception $e) {
    echo 'Exception when calling DEVICESETTINGSApi->videooutputinterfacePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DEVICESETTINGSApi;

my $api_instance = WWW::SwaggerClient::DEVICESETTINGSApi->new();
my $videooutput = ; # Object | Device operation mode `sdi` `hdmi` `LowLatency` `NormalMode`

eval { 
    $api_instance->videooutputinterfacePost(videooutput => $videooutput);
};
if ($@) {
    warn "Exception when calling DEVICESETTINGSApi->videooutputinterfacePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DEVICESETTINGSApi()
videooutput =  # Object | Device operation mode `sdi` `hdmi` `LowLatency` `NormalMode` (optional)

try: 
    # Set base operation modes of your BirdDog device
    api_instance.videooutputinterface_post(videooutput=videooutput)
except ApiException as e:
    print("Exception when calling DEVICESETTINGSApi->videooutputinterfacePost: %s\n" % e)

Parameters

Header parameters
Name Description
videooutput
Object (string)
Device videooutput mode `sdi` `hdmi` `LowLatency` `NormalMode`

Responses

Status: default - Once accepted, the API will return confirmation of the new mode set

Example data

Content-Type: Example Status response
NormalMode

NDIENCODE

encodeTransportGet

Retrieve current NDI Network Settings

This shows you NDI network settings.


/encodeTransport

Usage and SDK Samples

curl -X GET\
-H "Accept: text"\
"http://192.168.2.197:8080/encodeTransport?Txpm=&Txnetprefix=&Txnetmask=&Txmcttl="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NDIENCODEApi;

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

public class NDIENCODEApiExample {

    public static void main(String[] args) {
        
        NDIENCODEApi apiInstance = new NDIENCODEApi();
        Object txpm = ; // Object | Multicast, TCP, Multi-TCP, UDP
        Object txnetprefix = ; // Object | xxx.xxx.xxx.xxx
        Object txnetmask = ; // Object | xxx.xxx.xxx.xxx
        Object txmcttl = ; // Object | 1
        try {
            apiInstance.encodeTransportGet(txpm, txnetprefix, txnetmask, txmcttl);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIENCODEApi#encodeTransportGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NDIENCODEApi;

public class NDIENCODEApiExample {

    public static void main(String[] args) {
        NDIENCODEApi apiInstance = new NDIENCODEApi();
        Object txpm = ; // Object | Multicast, TCP, Multi-TCP, UDP
        Object txnetprefix = ; // Object | xxx.xxx.xxx.xxx
        Object txnetmask = ; // Object | xxx.xxx.xxx.xxx
        Object txmcttl = ; // Object | 1
        try {
            apiInstance.encodeTransportGet(txpm, txnetprefix, txnetmask, txmcttl);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIENCODEApi#encodeTransportGet");
            e.printStackTrace();
        }
    }
}
Object *txpm = ; // Multicast, TCP, Multi-TCP, UDP (optional)
Object *txnetprefix = ; // xxx.xxx.xxx.xxx (optional)
Object *txnetmask = ; // xxx.xxx.xxx.xxx (optional)
Object *txmcttl = ; // 1 (optional)

NDIENCODEApi *apiInstance = [[NDIENCODEApi alloc] init];

// Retrieve current NDI Network Settings
[apiInstance encodeTransportGetWith:txpm
    txnetprefix:txnetprefix
    txnetmask:txnetmask
    txmcttl:txmcttl
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
if (this.readyState == 4 && this.status == 200) {
  console.log(this.responseText);
 }
};
xhttp.open("GET", "http://192.168.2.197:8080/encodeTransport", true);
xhttp.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class encodeTransportGetExample
    {
        public void main()
        {

            var apiInstance = new NDIENCODEApi();
            var txpm = new Object(); // Object | Multicast, TCP, Multi-TCP, UDP (optional) 
            var txnetprefix = new Object(); // Object | xxx.xxx.xxx.xxx (optional) 
            var txnetmask = new Object(); // Object | xxx.xxx.xxx.xxx (optional) 
            var txmcttl = new Object(); // Object | 1 (optional) 

            try
            {
                // Retrieve current NDI Network Settings
                apiInstance.encodeTransportGet(txpm, txnetprefix, txnetmask, txmcttl);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NDIENCODEApi.encodeTransportGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNDIENCODEApi();
$txpm = ; // Object | Multicast, TCP, Multi-TCP, UDP
$txnetprefix = ; // Object | xxx.xxx.xxx.xxx
$txnetmask = ; // Object | xxx.xxx.xxx.xxx
$txmcttl = ; // Object | 1

try {
    $api_instance->encodeTransportGet($txpm, $txnetprefix, $txnetmask, $txmcttl);
} catch (Exception $e) {
    echo 'Exception when calling NDIENCODEApi->encodeTransportGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NDIENCODEApi;

my $api_instance = WWW::SwaggerClient::NDIENCODEApi->new();
my $txpm = ; # Object | Multicast, TCP, Multi-TCP, UDP
my $txnetprefix = ; # Object | xxx.xxx.xxx.xxx
my $txnetmask = ; # Object | xxx.xxx.xxx.xxx
my $txmcttl = ; # Object | 1

eval { 
    $api_instance->encodeTransportGet(txpm => $txpm, txnetprefix => $txnetprefix, txnetmask => $txnetmask, txmcttl => $txmcttl);
};
if ($@) {
    warn "Exception when calling NDIENCODEApi->encodeTransportGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NDIENCODEApi()
txpm =  # Object | Multicast, TCP, Multi-TCP, UDP (optional)
txnetprefix =  # Object | xxx.xxx.xxx.xxx (optional)
txnetmask =  # Object | xxx.xxx.xxx.xxx (optional)
txmcttl =  # Object | 1 (optional)

try: 
    # Retrieve current NDI Network Settings
    api_instance.encode_transport_get(txpm=txpm, txnetprefix=txnetprefix, txnetmask=txnetmask, txmcttl=txmcttl)
except ApiException as e:
    print("Exception when calling NDIENCODEApi->encodeTransportGet: %s\n" % e)

Parameters

Query parameters
Name Description
Txpm
Object (string)
Multicast, TCP, Multi-TCP, UDP
Txnetprefix
Object (string)
xxx.xxx.xxx.xxx
Txnetmask
Object (string)
xxx.xxx.xxx.xxx
Txmcttl
Object (string)
1

Responses

Status: default - Current NDI network settings are displayed

Example data

Content-Type: Example Status response
{"Txpm":"TCP","Txnetprefix":"xxx.xxx.xxx.xxx","Txnetmask":"xxx.xxx.xxx.xxx","Txmcttl":"1"}

encodeTransportPost

Set NDI Network Settings

This command allows you to change NDI network settings.


/encodeTransport

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json"\
-d {\"Txpm\":\"TCP\",\"Txnetprefix\":\"xxx.xxx.xxx.xxx\",\"Txnetmask\":\"xxx.xxx.xxx.xxx\",\"Txmcttl\":\"1\"} http://192.168.2.197:8080/encodeTransport
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NDIENCODEApi;

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

public class NDIENCODEApiExample {

    public static void main(String[] args) {
        
        NDIENCODEApi apiInstance = new NDIENCODEApi();
        Object txpm = ; // Object | Multicast, TCP, Multi-TCP, UDP
        Object txnetprefix = ; // Object | xxx.xxx.xxx.xxx
        Object txnetmask = ; // Object | xxx.xxx.xxx.xxx
        Object txmcttl = ; // Object | 1
        try {
            apiInstance.encodeTransportPost(txpm, txnetprefix, txnetmask, txmcttl);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIENCODEApi#encodeTransportPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NDIENCODEApi;

public class NDIENCODEApiExample {

    public static void main(String[] args) {
        NDIENCODEApi apiInstance = new NDIENCODEApi();
        Object txpm = ; // Object | Multicast, TCP, Multi-TCP, UDP
        Object txnetprefix = ; // Object | xxx.xxx.xxx.xxx
        Object txnetmask = ; // Object | xxx.xxx.xxx.xxx
        Object txmcttl = ; // Object | 1
        try {
            apiInstance.encodeTransportPost(txpm, txnetprefix, txnetmask, txmcttl);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIENCODEApi#encodeTransportPost");
            e.printStackTrace();
        }
    }
}
Object *txpm = ; // Multicast, TCP, Multi-TCP, UDP (optional)
Object *txnetprefix = ; // xxx.xxx.xxx.xxx (optional)
Object *txnetmask = ; // xxx.xxx.xxx.xxx (optional)
Object *txmcttl = ; // 1 (optional)

NDIENCODEApi *apiInstance = [[NDIENCODEApi alloc] init];

// Set NDI Network Settings
[apiInstance encodeTransportPostWith:txpm
    txnetprefix:txnetprefix
    txnetmask:txnetmask
    txmcttl:txmcttl
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhr = new XMLHttpRequest();
var url = "http://192.168.2.197:8080/encodeTransport";
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/json");
xhr.onreadystatechange = function () {
    if (xhr.readyState === 4 && xhr.status === 200) {
	  console.log(xhr.responseText);
    }
};
var data = JSON.stringify({"Txpm":"TCP","Txnetprefix":"xxx.xxx.xxx.xxx","Txnetmask":"xxx.xxx.xxx.xxx","Txmcttl":"1"});
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class encodeTransportPostExample
    {
        public void main()
        {

            var apiInstance = new NDIENCODEApi();
            var txpm = new Object(); // Object | Multicast, TCP, Multi-TCP, UDP (optional) 
            var txnetprefix = new Object(); // Object | xxx.xxx.xxx.xxx (optional) 
            var txnetmask = new Object(); // Object | xxx.xxx.xxx.xxx (optional) 
            var txmcttl = new Object(); // Object | 1 (optional) 

            try
            {
                // Set NDI Network Settings
                apiInstance.encodeTransportPost(txpm, txnetprefix, txnetmask, txmcttl);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NDIENCODEApi.encodeTransportPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNDIENCODEApi();
$txpm = ; // Object | Multicast, TCP, Multi-TCP, UDP
$txnetprefix = ; // Object | xxx.xxx.xxx.xxx
$txnetmask = ; // Object | xxx.xxx.xxx.xxx
$txmcttl = ; // Object | 1

try {
    $api_instance->encodeTransportPost($txpm, $txnetprefix, $txnetmask, $txmcttl);
} catch (Exception $e) {
    echo 'Exception when calling NDIENCODEApi->encodeTransportPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NDIENCODEApi;

my $api_instance = WWW::SwaggerClient::NDIENCODEApi->new();
my $txpm = ; # Object | Multicast, TCP, Multi-TCP, UDP
my $txnetprefix = ; # Object | xxx.xxx.xxx.xxx
my $txnetmask = ; # Object | xxx.xxx.xxx.xxx
my $txmcttl = ; # Object | 1

eval { 
    $api_instance->encodeTransportPost(txpm => $txpm, txnetprefix => $txnetprefix, txnetmask => $txnetmask, txmcttl => $txmcttl);
};
if ($@) {
    warn "Exception when calling NDIENCODEApi->encodeTransportPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NDIENCODEApi()
txpm =  # Object | Multicast, TCP, Multi-TCP, UDP (optional)
txnetprefix =  # Object | xxx.xxx.xxx.xxx (optional)
txnetmask =  # Object | xxx.xxx.xxx.xxx (optional)
txmcttl =  # Object | 1 (optional)

try: 
    # Set NDI Network Settings
    api_instance.encode_transport_post(txpm=txpm, txnetprefix=txnetprefix, txnetmask=txnetmask, txmcttl=txmcttl)
except ApiException as e:
    print("Exception when calling NDIENCODEApi->encodeTransportPost: %s\n" % e)

Parameters

Query parameters
Name Description
Txpm
Object (string)
Multicast, TCP, Multi-TCP, UDP
Txnetprefix
Object (string)
xxx.xxx.xxx.xxx
Txnetmask
Object (string)
xxx.xxx.xxx.xxx
Txmcttl
Object (string)
1

Responses

Status: default - Once accepted, the API will update NDI network settings.

Example data

Content-Type: Example Status response
{"Txpm":"TCP","Txnetprefix":"xxx.xxx.xxx.xxx","Txnetmask":"xxx.xxx.xxx.xxx","Txmcttl":"1"}

encodesetupGet

Retrieve Encode Settings

This command will fetch current encode settings


/encodesetup

Usage and SDK Samples

curl -X GET\
-H "Accept: text"\
"http://192.168.2.197:8080/encodesetup?ChNum=&VideoFormat=&VideoSampleRate=&ColorBitDepth=&StreamName=&NDIAudio=&ScreenSaverMode=&BandwidthMode=&BandwidthSelect=&LoopTally=&TallyMode=&VideoCSC=&NDIGroup=&NDIGroupName="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NDIENCODEApi;

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

public class NDIENCODEApiExample {

    public static void main(String[] args) {
        
        NDIENCODEApi apiInstance = new NDIENCODEApi();
        Object chNum = ; // Object | Channel No. Range 1 to 4
        Object videoFormat = ; // Object | VideoFormat
        Object videoSampleRate = ; // Object | 420, 422, 444
        Object colorBitDepth = ; // Object | 8Bit,10Bit,12Bit
        Object streamName = ; // Object | Name of Stream
        Object nDIAudio = ; // Object | NDIAudioMain,NDIAudioAnalog, NDIAudioMute
        Object screenSaverMode = ; // Object | BirdDogSS, BlackSS, CaptureSS
        Object bandwidthMode = ; // Object | Manual, NDIManaged
        Object bandwidthSelect = ; // Object | Range (60 to 360)
        Object loopTally = ; // Object | LoopTallyEn,LoopTallyDis
        Object tallyMode = ; // Object | TallyOn, TallyOff, VideoMode
        Object videoCSC = ; // Object | NoCSC, RGB, YVU, YUV444, YVU444
        Object nDIGroup = ; // Object | NDIGroupEn,NDIGroupDis
        Object nDIGroupName = ; // Object | BirdDog
        try {
            apiInstance.encodesetupGet(chNum, videoFormat, videoSampleRate, colorBitDepth, streamName, nDIAudio, screenSaverMode, bandwidthMode, bandwidthSelect, loopTally, tallyMode, videoCSC, nDIGroup, nDIGroupName);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIENCODEApi#encodesetupGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NDIENCODEApi;

public class NDIENCODEApiExample {

    public static void main(String[] args) {
        NDIENCODEApi apiInstance = new NDIENCODEApi();
        Object chNum = ; // Object | Channel No. Range 1 to 4
        Object videoFormat = ; // Object | VideoFormat
        Object videoSampleRate = ; // Object | 420, 422, 444
        Object colorBitDepth = ; // Object | 8Bit,10Bit,12Bit
        Object streamName = ; // Object | Name of Stream
        Object nDIAudio = ; // Object | NDIAudioMain,NDIAudioAnalog, NDIAudioMute
        Object screenSaverMode = ; // Object | BirdDogSS, BlackSS, CaptureSS
        Object bandwidthMode = ; // Object | Manual, NDIManaged
        Object bandwidthSelect = ; // Object | Range (60 to 360)
        Object loopTally = ; // Object | LoopTallyEn,LoopTallyDis
        Object tallyMode = ; // Object | TallyOn, TallyOff, VideoMode
        Object videoCSC = ; // Object | NoCSC, RGB, YVU, YUV444, YVU444
        Object nDIGroup = ; // Object | NDIGroupEn,NDIGroupDis
        Object nDIGroupName = ; // Object | BirdDog
        try {
            apiInstance.encodesetupGet(chNum, videoFormat, videoSampleRate, colorBitDepth, streamName, nDIAudio, screenSaverMode, bandwidthMode, bandwidthSelect, loopTally, tallyMode, videoCSC, nDIGroup, nDIGroupName);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIENCODEApi#encodesetupGet");
            e.printStackTrace();
        }
    }
}
Object *chNum = ; // Channel No. Range 1 to 4 (optional)
Object *videoFormat = ; // VideoFormat (optional)
Object *videoSampleRate = ; // 420, 422, 444 (optional)
Object *colorBitDepth = ; // 8Bit,10Bit,12Bit (optional)
Object *streamName = ; // Name of Stream (optional)
Object *nDIAudio = ; // NDIAudioMain,NDIAudioAnalog, NDIAudioMute (optional)
Object *screenSaverMode = ; // BirdDogSS, BlackSS, CaptureSS (optional)
Object *bandwidthMode = ; // Manual, NDIManaged (optional)
Object *bandwidthSelect = ; // Range (60 to 360) (optional)
Object *loopTally = ; // LoopTallyEn,LoopTallyDis (optional)
Object *tallyMode = ; // TallyOn, TallyOff, VideoMode (optional)
Object *videoCSC = ; // NoCSC, RGB, YVU, YUV444, YVU444 (optional)
Object *nDIGroup = ; // NDIGroupEn,NDIGroupDis (optional)
Object *nDIGroupName = ; // BirdDog (optional)

NDIENCODEApi *apiInstance = [[NDIENCODEApi alloc] init];

// Retrieve Encode Settings
[apiInstance encodesetupGetWith:chNum
    videoFormat:videoFormat
    videoSampleRate:videoSampleRate
    colorBitDepth:colorBitDepth
    streamName:streamName
    nDIAudio:nDIAudio
    screenSaverMode:screenSaverMode
    bandwidthMode:bandwidthMode
    bandwidthSelect:bandwidthSelect
    loopTally:loopTally
    tallyMode:tallyMode
    videoCSC:videoCSC
    nDIGroup:nDIGroup
    nDIGroupName:nDIGroupName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
if (this.readyState == 4 && this.status == 200) {
  console.log(this.responseText);
 }
};
xhttp.open("GET", "http://192.168.2.197:8080/encodesetup", true);
xhttp.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class encodesetupGetExample
    {
        public void main()
        {

            var apiInstance = new NDIENCODEApi();
            var chNum = new Object(); // Object | Channel No. Range 1 to 4 (optional) 
            var videoFormat = new Object(); // Object | VideoFormat (optional) 
            var videoSampleRate = new Object(); // Object | 420, 422, 444 (optional) 
            var colorBitDepth = new Object(); // Object | 8Bit,10Bit,12Bit (optional) 
            var streamName = new Object(); // Object | Name of Stream (optional) 
            var nDIAudio = new Object(); // Object | NDIAudioMain,NDIAudioAnalog, NDIAudioMute (optional) 
            var screenSaverMode = new Object(); // Object | BirdDogSS, BlackSS, CaptureSS (optional) 
            var bandwidthMode = new Object(); // Object | Manual, NDIManaged (optional) 
            var bandwidthSelect = new Object(); // Object | Range (60 to 360) (optional) 
            var loopTally = new Object(); // Object | LoopTallyEn,LoopTallyDis (optional) 
            var tallyMode = new Object(); // Object | TallyOn, TallyOff, VideoMode (optional) 
            var videoCSC = new Object(); // Object | NoCSC, RGB, YVU, YUV444, YVU444 (optional) 
            var nDIGroup = new Object(); // Object | NDIGroupEn,NDIGroupDis (optional) 
            var nDIGroupName = new Object(); // Object | BirdDog (optional) 

            try
            {
                // Retrieve Encode Settings
                apiInstance.encodesetupGet(chNum, videoFormat, videoSampleRate, colorBitDepth, streamName, nDIAudio, screenSaverMode, bandwidthMode, bandwidthSelect, loopTally, tallyMode, videoCSC, nDIGroup, nDIGroupName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NDIENCODEApi.encodesetupGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNDIENCODEApi();
$chNum = ; // Object | Channel No. Range 1 to 4
$videoFormat = ; // Object | VideoFormat
$videoSampleRate = ; // Object | 420, 422, 444
$colorBitDepth = ; // Object | 8Bit,10Bit,12Bit
$streamName = ; // Object | Name of Stream
$nDIAudio = ; // Object | NDIAudioMain,NDIAudioAnalog, NDIAudioMute
$screenSaverMode = ; // Object | BirdDogSS, BlackSS, CaptureSS
$bandwidthMode = ; // Object | Manual, NDIManaged
$bandwidthSelect = ; // Object | Range (60 to 360)
$loopTally = ; // Object | LoopTallyEn,LoopTallyDis
$tallyMode = ; // Object | TallyOn, TallyOff, VideoMode
$videoCSC = ; // Object | NoCSC, RGB, YVU, YUV444, YVU444
$nDIGroup = ; // Object | NDIGroupEn,NDIGroupDis
$nDIGroupName = ; // Object | BirdDog

try {
    $api_instance->encodesetupGet($chNum, $videoFormat, $videoSampleRate, $colorBitDepth, $streamName, $nDIAudio, $screenSaverMode, $bandwidthMode, $bandwidthSelect, $loopTally, $tallyMode, $videoCSC, $nDIGroup, $nDIGroupName);
} catch (Exception $e) {
    echo 'Exception when calling NDIENCODEApi->encodesetupGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NDIENCODEApi;

my $api_instance = WWW::SwaggerClient::NDIENCODEApi->new();
my $chNum = ; # Object | Channel No. Range 1 to 4
my $videoFormat = ; # Object | VideoFormat
my $videoSampleRate = ; # Object | 420, 422, 444
my $colorBitDepth = ; # Object | 8Bit,10Bit,12Bit
my $streamName = ; # Object | Name of Stream
my $nDIAudio = ; # Object | NDIAudioMain,NDIAudioAnalog, NDIAudioMute
my $screenSaverMode = ; # Object | BirdDogSS, BlackSS, CaptureSS
my $bandwidthMode = ; # Object | Manual, NDIManaged
my $bandwidthSelect = ; # Object | Range (60 to 360)
my $loopTally = ; # Object | LoopTallyEn,LoopTallyDis
my $tallyMode = ; # Object | TallyOn, TallyOff, VideoMode
my $videoCSC = ; # Object | NoCSC, RGB, YVU, YUV444, YVU444
my $nDIGroup = ; # Object | NDIGroupEn,NDIGroupDis
my $nDIGroupName = ; # Object | BirdDog

eval { 
    $api_instance->encodesetupGet(chNum => $chNum, videoFormat => $videoFormat, videoSampleRate => $videoSampleRate, colorBitDepth => $colorBitDepth, streamName => $streamName, nDIAudio => $nDIAudio, screenSaverMode => $screenSaverMode, bandwidthMode => $bandwidthMode, bandwidthSelect => $bandwidthSelect, loopTally => $loopTally, tallyMode => $tallyMode, videoCSC => $videoCSC, nDIGroup => $nDIGroup, nDIGroupName => $nDIGroupName);
};
if ($@) {
    warn "Exception when calling NDIENCODEApi->encodesetupGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NDIENCODEApi()
chNum =  # Object | Channel No. Range 1 to 4 (optional)
videoFormat =  # Object | VideoFormat (optional)
videoSampleRate =  # Object | 420, 422, 444 (optional)
colorBitDepth =  # Object | 8Bit,10Bit,12Bit (optional)
streamName =  # Object | Name of Stream (optional)
nDIAudio =  # Object | NDIAudioMain,NDIAudioAnalog, NDIAudioMute (optional)
screenSaverMode =  # Object | BirdDogSS, BlackSS, CaptureSS (optional)
bandwidthMode =  # Object | Manual, NDIManaged (optional)
bandwidthSelect =  # Object | Range (60 to 360) (optional)
loopTally =  # Object | LoopTallyEn,LoopTallyDis (optional)
tallyMode =  # Object | TallyOn, TallyOff, VideoMode (optional)
videoCSC =  # Object | NoCSC, RGB, YVU, YUV444, YVU444 (optional)
nDIGroup =  # Object | NDIGroupEn,NDIGroupDis (optional)
nDIGroupName =  # Object | BirdDog (optional)

try: 
    # Retrieve Encode Settings
    api_instance.encodesetup_get(chNum=chNum, videoFormat=videoFormat, videoSampleRate=videoSampleRate, colorBitDepth=colorBitDepth, streamName=streamName, nDIAudio=nDIAudio, screenSaverMode=screenSaverMode, bandwidthMode=bandwidthMode, bandwidthSelect=bandwidthSelect, loopTally=loopTally, tallyMode=tallyMode, videoCSC=videoCSC, nDIGroup=nDIGroup, nDIGroupName=nDIGroupName)
except ApiException as e:
    print("Exception when calling NDIENCODEApi->encodesetupGet: %s\n" % e)

Parameters

Query parameters
Name Description
ChNum
Object (string)
Channel No. Range 1 to 4
VideoFormat
Object (string)
VideoFormat
VideoSampleRate
Object (string)
420, 422, 444
ColorBitDepth
Object (string)
8Bit,10Bit,12Bit
StreamName
Object (string)
Name of Stream
NDIAudio
Object (string)
NDIAudioMain,NDIAudioAnalog, NDIAudioMute
ScreenSaverMode
Object (string)
BirdDogSS, BlackSS, CaptureSS
BandwidthMode
Object (string)
Manual, NDIManaged
BandwidthSelect
Object (string)
Range (60 to 360)
LoopTally
Object (string)
LoopTallyEn,LoopTallyDis
TallyMode
Object (string)
TallyOn, TallyOff, VideoMode
VideoCSC
Object (string)
NoCSC, RGB, YVU, YUV444, YVU444
NDIGroup
Object (string)
NDIGroupEn,NDIGroupDis
NDIGroupName
Object (string)
BirdDog

Responses

Status: default - Device standard response

Example data

Content-Type: Example Status response
{"ChNum":"1","VideoFormat" :"<videoformat>","VideoSampleRate":"420","ColorBitDepth" :" 8Bit","StreamName" :"<name of stream>","NDIAudio":"NDIAudioAnalog","ScreenSaverMode":"CaptureSS","BandwidthMode":"NDIManaged","BandwidthSelect":"120","LoopTally":"LoopTallyDis","TallyMode":"TallyOn","VideoCSC":"RGB","NDIGroup":"NDIGroupDis","NDIGroupName":"<BirdDog>"}

encodesetupPost

Set Encode Settings

This command sets encode settings


/encodesetup

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json"\
-d {\"ChNum\":\"1\",\"VideoFormat\" :\"videoformat\",\"VideoSampleRate\":\"420\",\"ColorBitDepth\" :\" 8Bit\",\"StreamName\" :\"name of stream\",\"NDIAudio\":\"NDIAudioAnalog\",\"ScreenSaverMode\":\"CaptureSS\",\"BandwidthMode\":\"NDIManaged\",\"BandwidthSelect\":\"120\",\"LoopTally\":\"LoopTallyDis\",\"TallyMode\":\"TallyOn\",\"VideoCSC\":\"RGB\",\"NDIGroup\":\"NDIGroupDis\",\"NDIGroupName\":\"BirdDog\"} http://192.168.2.197:8080/encodesetup
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NDIENCODEApi;

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

public class NDIENCODEApiExample {

    public static void main(String[] args) {
        
        NDIENCODEApi apiInstance = new NDIENCODEApi();
        Object chNum = ; // Object | Channel No. Range 1 to 4
        Object videoFormat = ; // Object | VideoFormat
        Object videoSampleRate = ; // Object | 420, 422, 444
        Object colorBitDepth = ; // Object | 8Bit,10Bit,12Bit
        Object streamName = ; // Object | Name of Stream
        Object nDIAudio = ; // Object | NDIAudioMain,NDIAudioAnalog, NDIAudioMute
        Object screenSaverMode = ; // Object | BirdDogSS, BlackSS, CaptureSS
        Object bandwidthMode = ; // Object | Manual, NDIManaged
        Object bandwidthSelect = ; // Object | Range (60 to 360)
        Object loopTally = ; // Object | LoopTallyEn,LoopTallyDis
        Object tallyMode = ; // Object | TallyOn, TallyOff, VideoMode
        Object videoCSC = ; // Object | NoCSC, RGB, YVU, YUV444, YVU444
        Object nDIGroup = ; // Object | NDIGroupEn,NDIGroupDis
        Object nDIGroupName = ; // Object | BirdDog
        try {
            apiInstance.encodesetupPost(chNum, videoFormat, videoSampleRate, colorBitDepth, streamName, nDIAudio, screenSaverMode, bandwidthMode, bandwidthSelect, loopTally, tallyMode, videoCSC, nDIGroup, nDIGroupName);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIENCODEApi#encodesetupPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NDIENCODEApi;

public class NDIENCODEApiExample {

    public static void main(String[] args) {
        NDIENCODEApi apiInstance = new NDIENCODEApi();
        Object chNum = ; // Object | Channel No. Range 1 to 4
        Object videoFormat = ; // Object | VideoFormat
        Object videoSampleRate = ; // Object | 420, 422, 444
        Object colorBitDepth = ; // Object | 8Bit,10Bit,12Bit
        Object streamName = ; // Object | Name of Stream
        Object nDIAudio = ; // Object | NDIAudioMain,NDIAudioAnalog, NDIAudioMute
        Object screenSaverMode = ; // Object | BirdDogSS, BlackSS, CaptureSS
        Object bandwidthMode = ; // Object | Manual, NDIManaged
        Object bandwidthSelect = ; // Object | Range (60 to 360)
        Object loopTally = ; // Object | LoopTallyEn,LoopTallyDis
        Object tallyMode = ; // Object | TallyOn, TallyOff, VideoMode
        Object videoCSC = ; // Object | NoCSC, RGB, YVU, YUV444, YVU444
        Object nDIGroup = ; // Object | NDIGroupEn,NDIGroupDis
        Object nDIGroupName = ; // Object | BirdDog
        try {
            apiInstance.encodesetupPost(chNum, videoFormat, videoSampleRate, colorBitDepth, streamName, nDIAudio, screenSaverMode, bandwidthMode, bandwidthSelect, loopTally, tallyMode, videoCSC, nDIGroup, nDIGroupName);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIENCODEApi#encodesetupPost");
            e.printStackTrace();
        }
    }
}
Object *chNum = ; // Channel No. Range 1 to 4 (optional)
Object *videoFormat = ; // VideoFormat (optional)
Object *videoSampleRate = ; // 420, 422, 444 (optional)
Object *colorBitDepth = ; // 8Bit,10Bit,12Bit (optional)
Object *streamName = ; // Name of Stream (optional)
Object *nDIAudio = ; // NDIAudioMain,NDIAudioAnalog, NDIAudioMute (optional)
Object *screenSaverMode = ; // BirdDogSS, BlackSS, CaptureSS (optional)
Object *bandwidthMode = ; // Manual, NDIManaged (optional)
Object *bandwidthSelect = ; // Range (60 to 360) (optional)
Object *loopTally = ; // LoopTallyEn,LoopTallyDis (optional)
Object *tallyMode = ; // TallyOn, TallyOff, VideoMode (optional)
Object *videoCSC = ; // NoCSC, RGB, YVU, YUV444, YVU444 (optional)
Object *nDIGroup = ; // NDIGroupEn,NDIGroupDis (optional)
Object *nDIGroupName = ; // BirdDog (optional)

NDIENCODEApi *apiInstance = [[NDIENCODEApi alloc] init];

// Set Encode Settings
[apiInstance encodesetupPostWith:chNum
    videoFormat:videoFormat
    videoSampleRate:videoSampleRate
    colorBitDepth:colorBitDepth
    streamName:streamName
    nDIAudio:nDIAudio
    screenSaverMode:screenSaverMode
    bandwidthMode:bandwidthMode
    bandwidthSelect:bandwidthSelect
    loopTally:loopTally
    tallyMode:tallyMode
    videoCSC:videoCSC
    nDIGroup:nDIGroup
    nDIGroupName:nDIGroupName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhr = new XMLHttpRequest();
var url = "http://192.168.2.197:8080/encodesetup";
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/json");
xhr.onreadystatechange = function () {
    if (xhr.readyState === 4 && xhr.status === 200) {
	  console.log(xhr.responseText);
    }
};
var data = JSON.stringify({"ChNum":"1","VideoFormat" :"videoformat","VideoSampleRate":"420","ColorBitDepth" :" 8Bit","StreamName" :"name of stream","NDIAudio":"NDIAudioAnalog","ScreenSaverMode":"CaptureSS","BandwidthMode":"NDIManaged","BandwidthSelect":"120","LoopTally":"LoopTallyDis","TallyMode":"TallyOn","VideoCSC":"RGB","NDIGroup":"NDIGroupDis","NDIGroupName":"BirdDog"});
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class encodesetupPostExample
    {
        public void main()
        {

            var apiInstance = new NDIENCODEApi();
            var chNum = new Object(); // Object | Channel No. Range 1 to 4 (optional) 
            var videoFormat = new Object(); // Object | VideoFormat (optional) 
            var videoSampleRate = new Object(); // Object | 420, 422, 444 (optional) 
            var colorBitDepth = new Object(); // Object | 8Bit,10Bit,12Bit (optional) 
            var streamName = new Object(); // Object | Name of Stream (optional) 
            var nDIAudio = new Object(); // Object | NDIAudioMain,NDIAudioAnalog, NDIAudioMute (optional) 
            var screenSaverMode = new Object(); // Object | BirdDogSS, BlackSS, CaptureSS (optional) 
            var bandwidthMode = new Object(); // Object | Manual, NDIManaged (optional) 
            var bandwidthSelect = new Object(); // Object | Range (60 to 360) (optional) 
            var loopTally = new Object(); // Object | LoopTallyEn,LoopTallyDis (optional) 
            var tallyMode = new Object(); // Object | TallyOn, TallyOff, VideoMode (optional) 
            var videoCSC = new Object(); // Object | NoCSC, RGB, YVU, YUV444, YVU444 (optional) 
            var nDIGroup = new Object(); // Object | NDIGroupEn,NDIGroupDis (optional) 
            var nDIGroupName = new Object(); // Object | BirdDog (optional) 

            try
            {
                // Set Encode Settings
                apiInstance.encodesetupPost(chNum, videoFormat, videoSampleRate, colorBitDepth, streamName, nDIAudio, screenSaverMode, bandwidthMode, bandwidthSelect, loopTally, tallyMode, videoCSC, nDIGroup, nDIGroupName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NDIENCODEApi.encodesetupPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNDIENCODEApi();
$chNum = ; // Object | Channel No. Range 1 to 4
$videoFormat = ; // Object | VideoFormat
$videoSampleRate = ; // Object | 420, 422, 444
$colorBitDepth = ; // Object | 8Bit,10Bit,12Bit
$streamName = ; // Object | Name of Stream
$nDIAudio = ; // Object | NDIAudioMain,NDIAudioAnalog, NDIAudioMute
$screenSaverMode = ; // Object | BirdDogSS, BlackSS, CaptureSS
$bandwidthMode = ; // Object | Manual, NDIManaged
$bandwidthSelect = ; // Object | Range (60 to 360)
$loopTally = ; // Object | LoopTallyEn,LoopTallyDis
$tallyMode = ; // Object | TallyOn, TallyOff, VideoMode
$videoCSC = ; // Object | NoCSC, RGB, YVU, YUV444, YVU444
$nDIGroup = ; // Object | NDIGroupEn,NDIGroupDis
$nDIGroupName = ; // Object | BirdDog

try {
    $api_instance->encodesetupPost($chNum, $videoFormat, $videoSampleRate, $colorBitDepth, $streamName, $nDIAudio, $screenSaverMode, $bandwidthMode, $bandwidthSelect, $loopTally, $tallyMode, $videoCSC, $nDIGroup, $nDIGroupName);
} catch (Exception $e) {
    echo 'Exception when calling NDIENCODEApi->encodesetupPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NDIENCODEApi;

my $api_instance = WWW::SwaggerClient::NDIENCODEApi->new();
my $chNum = ; # Object | Channel No. Range 1 to 4
my $videoFormat = ; # Object | VideoFormat
my $videoSampleRate = ; # Object | 420, 422, 444
my $colorBitDepth = ; # Object | 8Bit,10Bit,12Bit
my $streamName = ; # Object | Name of Stream
my $nDIAudio = ; # Object | NDIAudioMain,NDIAudioAnalog, NDIAudioMute
my $screenSaverMode = ; # Object | BirdDogSS, BlackSS, CaptureSS
my $bandwidthMode = ; # Object | Manual, NDIManaged
my $bandwidthSelect = ; # Object | Range (60 to 360)
my $loopTally = ; # Object | LoopTallyEn,LoopTallyDis
my $tallyMode = ; # Object | TallyOn, TallyOff, VideoMode
my $videoCSC = ; # Object | NoCSC, RGB, YVU, YUV444, YVU444
my $nDIGroup = ; # Object | NDIGroupEn,NDIGroupDis
my $nDIGroupName = ; # Object | BirdDog

eval { 
    $api_instance->encodesetupPost(chNum => $chNum, videoFormat => $videoFormat, videoSampleRate => $videoSampleRate, colorBitDepth => $colorBitDepth, streamName => $streamName, nDIAudio => $nDIAudio, screenSaverMode => $screenSaverMode, bandwidthMode => $bandwidthMode, bandwidthSelect => $bandwidthSelect, loopTally => $loopTally, tallyMode => $tallyMode, videoCSC => $videoCSC, nDIGroup => $nDIGroup, nDIGroupName => $nDIGroupName);
};
if ($@) {
    warn "Exception when calling NDIENCODEApi->encodesetupPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NDIENCODEApi()
chNum =  # Object | Channel No. Range 1 to 4 (optional)
videoFormat =  # Object | VideoFormat (optional)
videoSampleRate =  # Object | 420, 422, 444 (optional)
colorBitDepth =  # Object | 8Bit,10Bit,12Bit (optional)
streamName =  # Object | Name of Stream (optional)
nDIAudio =  # Object | NDIAudioMain,NDIAudioAnalog, NDIAudioMute (optional)
screenSaverMode =  # Object | BirdDogSS, BlackSS, CaptureSS (optional)
bandwidthMode =  # Object | Manual, NDIManaged (optional)
bandwidthSelect =  # Object | Range (60 to 360) (optional)
loopTally =  # Object | LoopTallyEn,LoopTallyDis (optional)
tallyMode =  # Object | TallyOn, TallyOff, VideoMode (optional)
videoCSC =  # Object | NoCSC, RGB, YVU, YUV444, YVU444 (optional)
nDIGroup =  # Object | NDIGroupEn,NDIGroupDis (optional)
nDIGroupName =  # Object | BirdDog (optional)

try: 
    # Set Encode Settings
    api_instance.encodesetup_post(chNum=chNum, videoFormat=videoFormat, videoSampleRate=videoSampleRate, colorBitDepth=colorBitDepth, streamName=streamName, nDIAudio=nDIAudio, screenSaverMode=screenSaverMode, bandwidthMode=bandwidthMode, bandwidthSelect=bandwidthSelect, loopTally=loopTally, tallyMode=tallyMode, videoCSC=videoCSC, nDIGroup=nDIGroup, nDIGroupName=nDIGroupName)
except ApiException as e:
    print("Exception when calling NDIENCODEApi->encodesetupPost: %s\n" % e)

Parameters

Query parameters
Name Description
ChNum
Object (string)
Channel No. Range 1 to 4
VideoFormat
Object (string)
VideoFormat
VideoSampleRate
Object (string)
420, 422, 444
ColorBitDepth
Object (string)
8Bit,10Bit,12Bit
StreamName
Object (string)
Name of Stream
NDIAudio
Object (string)
NDIAudioMain,NDIAudioAnalog, NDIAudioMute
ScreenSaverMode
Object (string)
BirdDogSS, BlackSS, CaptureSS
BandwidthMode
Object (string)
Manual, NDIManaged
BandwidthSelect
Object (string)
Range (60 to 360)
LoopTally
Object (string)
LoopTallyEn,LoopTallyDis
TallyMode
Object (string)
TallyOn, TallyOff, VideoMode
VideoCSC
Object (string)
NoCSC, RGB, YVU, YUV444, YVU444
NDIGroup
Object (string)
NDIGroupEn,NDIGroupDis
NDIGroupName
Object (string)
BirdDog

Responses

Status: default - Device standard response

Example data

Content-Type: Example Status response
{"ChNum":"1","VideoFormat" :"<videoformat>","VideoSampleRate":"420","ColorBitDepth" :" 8Bit","StreamName" :"<name of stream>","NDIAudio":"NDIAudioAnalog","ScreenSaverMode":"CaptureSS","BandwidthMode":"NDIManaged","BandwidthSelect":"120","LoopTally":"LoopTallyDis","TallyMode":"TallyOn","VideoCSC":"RGB","NDIGroup":"NDIGroupDis","NDIGroupName":"<BirdDog>"}

NDIDECODE

captureGet

Capture screensaver frame for Encode/Decode

This command will capture screensaver frame for Encode/Decode


/capture

Usage and SDK Samples

curl -X GET\
-H "Accept: text"\
"http://192.168.2.197:8080/capture?ChNum=&status="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NDIDECODEApi;

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

public class NDIDECODEApiExample {

    public static void main(String[] args) {
        
        NDIDECODEApi apiInstance = new NDIDECODEApi();
        Object chNum = ; // Object | Channel No. Range 1 to 4
        Object status = ; // Object | Encode, Decode
        try {
            apiInstance.captureGet(chNum, status);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIDECODEApi#captureGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NDIDECODEApi;

public class NDIDECODEApiExample {

    public static void main(String[] args) {
        NDIDECODEApi apiInstance = new NDIDECODEApi();
        Object chNum = ; // Object | Channel No. Range 1 to 4
        Object status = ; // Object | Encode, Decode
        try {
            apiInstance.captureGet(chNum, status);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIDECODEApi#captureGet");
            e.printStackTrace();
        }
    }
}
Object *chNum = ; // Channel No. Range 1 to 4 (optional)
Object *status = ; // Encode, Decode (optional)

NDIDECODEApi *apiInstance = [[NDIDECODEApi alloc] init];

// Capture screensaver frame for Encode/Decode
[apiInstance captureGetWith:chNum
    status:status
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
if (this.readyState == 4 && this.status == 200) {
  console.log(this.responseText);
 }
};
xhttp.open("GET", "http://192.168.2.197:8080/capture", true);
xhttp.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class captureGetExample
    {
        public void main()
        {

            var apiInstance = new NDIDECODEApi();
            var chNum = new Object(); // Object | Channel No. Range 1 to 4 (optional) 
            var status = new Object(); // Object | Encode, Decode (optional) 

            try
            {
                // Capture screensaver frame for Encode/Decode
                apiInstance.captureGet(chNum, status);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NDIDECODEApi.captureGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNDIDECODEApi();
$chNum = ; // Object | Channel No. Range 1 to 4
$status = ; // Object | Encode, Decode

try {
    $api_instance->captureGet($chNum, $status);
} catch (Exception $e) {
    echo 'Exception when calling NDIDECODEApi->captureGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NDIDECODEApi;

my $api_instance = WWW::SwaggerClient::NDIDECODEApi->new();
my $chNum = ; # Object | Channel No. Range 1 to 4
my $status = ; # Object | Encode, Decode

eval { 
    $api_instance->captureGet(chNum => $chNum, status => $status);
};
if ($@) {
    warn "Exception when calling NDIDECODEApi->captureGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NDIDECODEApi()
chNum =  # Object | Channel No. Range 1 to 4 (optional)
status =  # Object | Encode, Decode (optional)

try: 
    # Capture screensaver frame for Encode/Decode
    api_instance.capture_get(chNum=chNum, status=status)
except ApiException as e:
    print("Exception when calling NDIDECODEApi->captureGet: %s\n" % e)

Parameters

Query parameters
Name Description
ChNum
Object (string)
Channel No. Range 1 to 4
status
Object (string)
Encode, Decode

Responses

Status: default - Capture screensaver frame for Encode/Decode

Example data

Content-Type: Example Status response
Capture Success..

connectToGet

Retrieve connected NDI Source info (sourceName)

This shows you connected NDI Source info (sourceName)


/connectTo

Usage and SDK Samples

curl -X GET\
-H "Accept: text"\
"http://192.168.2.197:8080/connectTo?ChNum=&sourcename=&status="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NDIDECODEApi;

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

public class NDIDECODEApiExample {

    public static void main(String[] args) {
        
        NDIDECODEApi apiInstance = new NDIDECODEApi();
        Object chNum = ; // Object | Channel No. Range 1 to 4
        Object sourcename = ; // Object | None
        Object status = ; // Object | Status can be `Encode` or `Decode`
        try {
            apiInstance.connectToGet(chNum, sourcename, status);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIDECODEApi#connectToGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NDIDECODEApi;

public class NDIDECODEApiExample {

    public static void main(String[] args) {
        NDIDECODEApi apiInstance = new NDIDECODEApi();
        Object chNum = ; // Object | Channel No. Range 1 to 4
        Object sourcename = ; // Object | None
        Object status = ; // Object | Status can be `Encode` or `Decode`
        try {
            apiInstance.connectToGet(chNum, sourcename, status);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIDECODEApi#connectToGet");
            e.printStackTrace();
        }
    }
}
Object *chNum = ; // Channel No. Range 1 to 4 (optional)
Object *sourcename = ; // None (optional)
Object *status = ; // Status can be `Encode` or `Decode` (optional)

NDIDECODEApi *apiInstance = [[NDIDECODEApi alloc] init];

// Retrieve connected NDI Source info (sourceName)
[apiInstance connectToGetWith:chNum
    sourcename:sourcename
    status:status
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
if (this.readyState == 4 && this.status == 200) {
  console.log(this.responseText);
 }
};
xhttp.open("GET", "http://192.168.2.197:8080/connectTo", true);
xhttp.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class connectToGetExample
    {
        public void main()
        {

            var apiInstance = new NDIDECODEApi();
            var chNum = new Object(); // Object | Channel No. Range 1 to 4 (optional) 
            var sourcename = new Object(); // Object | None (optional) 
            var status = new Object(); // Object | Status can be `Encode` or `Decode` (optional) 

            try
            {
                // Retrieve connected NDI Source info (sourceName)
                apiInstance.connectToGet(chNum, sourcename, status);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NDIDECODEApi.connectToGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNDIDECODEApi();
$chNum = ; // Object | Channel No. Range 1 to 4
$sourcename = ; // Object | None
$status = ; // Object | Status can be `Encode` or `Decode`

try {
    $api_instance->connectToGet($chNum, $sourcename, $status);
} catch (Exception $e) {
    echo 'Exception when calling NDIDECODEApi->connectToGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NDIDECODEApi;

my $api_instance = WWW::SwaggerClient::NDIDECODEApi->new();
my $chNum = ; # Object | Channel No. Range 1 to 4
my $sourcename = ; # Object | None
my $status = ; # Object | Status can be `Encode` or `Decode`

eval { 
    $api_instance->connectToGet(chNum => $chNum, sourcename => $sourcename, status => $status);
};
if ($@) {
    warn "Exception when calling NDIDECODEApi->connectToGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NDIDECODEApi()
chNum =  # Object | Channel No. Range 1 to 4 (optional)
sourcename =  # Object | None (optional)
status =  # Object | Status can be `Encode` or `Decode` (optional)

try: 
    # Retrieve connected NDI Source info (sourceName)
    api_instance.connect_to_get(chNum=chNum, sourcename=sourcename, status=status)
except ApiException as e:
    print("Exception when calling NDIDECODEApi->connectToGet: %s\n" % e)

Parameters

Query parameters
Name Description
ChNum
Object (string)
Channel No. Range 1 to 4
sourcename
Object (string)
None
status
Object (string)
Status can be `Encode` or `Decode`

Responses

Status: default - Current connected NDI Source info (sourceName)

Example data

Content-Type: Example Status response
{"sourceName":"None"}

connectToPost

Connects to NDI Source

This connects to an NDI Source


/connectTo

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json"\
-d {\"sourceName\":\"None\"} http://192.168.2.197:8080/connectTo
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NDIDECODEApi;

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

public class NDIDECODEApiExample {

    public static void main(String[] args) {
        
        NDIDECODEApi apiInstance = new NDIDECODEApi();
        Object chNum = ; // Object | Channel No. Range 1 to 4
        Object sourcename = ; // Object | None
        Object status = ; // Object | Status can be `Encode` or `Decode`
        try {
            apiInstance.connectToPost(chNum, sourcename, status);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIDECODEApi#connectToPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NDIDECODEApi;

public class NDIDECODEApiExample {

    public static void main(String[] args) {
        NDIDECODEApi apiInstance = new NDIDECODEApi();
        Object chNum = ; // Object | Channel No. Range 1 to 4
        Object sourcename = ; // Object | None
        Object status = ; // Object | Status can be `Encode` or `Decode`
        try {
            apiInstance.connectToPost(chNum, sourcename, status);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIDECODEApi#connectToPost");
            e.printStackTrace();
        }
    }
}
Object *chNum = ; // Channel No. Range 1 to 4 (optional)
Object *sourcename = ; // None (optional)
Object *status = ; // Status can be `Encode` or `Decode` (optional)

NDIDECODEApi *apiInstance = [[NDIDECODEApi alloc] init];

// Connects to NDI Source
[apiInstance connectToPostWith:chNum
    sourcename:sourcename
    status:status
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhr = new XMLHttpRequest();
var url = "http://192.168.2.197:8080/connectTo";
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/json");
xhr.onreadystatechange = function () {
    if (xhr.readyState === 4 && xhr.status === 200) {
	  console.log(xhr.responseText);
    }
};
var data = JSON.stringify({"sourceName":"None"});
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class connectToPostExample
    {
        public void main()
        {

            var apiInstance = new NDIDECODEApi();
            var chNum = new Object(); // Object | Channel No. Range 1 to 4 (optional) 
            var sourcename = new Object(); // Object | None (optional) 
            var status = new Object(); // Object | Status can be `Encode` or `Decode` (optional) 

            try
            {
                // Connects to NDI Source
                apiInstance.connectToPost(chNum, sourcename, status);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NDIDECODEApi.connectToPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNDIDECODEApi();
$chNum = ; // Object | Channel No. Range 1 to 4
$sourcename = ; // Object | None
$status = ; // Object | Status can be `Encode` or `Decode`

try {
    $api_instance->connectToPost($chNum, $sourcename, $status);
} catch (Exception $e) {
    echo 'Exception when calling NDIDECODEApi->connectToPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NDIDECODEApi;

my $api_instance = WWW::SwaggerClient::NDIDECODEApi->new();
my $chNum = ; # Object | Channel No. Range 1 to 4
my $sourcename = ; # Object | None
my $status = ; # Object | Status can be `Encode` or `Decode`

eval { 
    $api_instance->connectToPost(chNum => $chNum, sourcename => $sourcename, status => $status);
};
if ($@) {
    warn "Exception when calling NDIDECODEApi->connectToPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NDIDECODEApi()
chNum =  # Object | Channel No. Range 1 to 4 (optional)
sourcename =  # Object | None (optional)
status =  # Object | Status can be `Encode` or `Decode` (optional)

try: 
    # Connects to NDI Source
    api_instance.connect_to_post(chNum=chNum, sourcename=sourcename, status=status)
except ApiException as e:
    print("Exception when calling NDIDECODEApi->connectToPost: %s\n" % e)

Parameters

Query parameters
Name Description
ChNum
Object (string)
Channel No. Range 1 to 4
sourcename
Object (string)
None
status
Object (string)
Status can be `Encode` or `Decode`

Responses

Status: default - Current NDI Source Name is displayed

Example data

Content-Type: Example Status response
{"sourceName":"None"}

decodeTransportGet

Retrieve NDI network settings

This command will get NDI network settings


/decodeTransport

Usage and SDK Samples

curl -X GET\
-H "Accept: text"\
"http://192.168.2.197:8080/decodeTransport?rxpm="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NDIDECODEApi;

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

public class NDIDECODEApiExample {

    public static void main(String[] args) {
        
        NDIDECODEApi apiInstance = new NDIDECODEApi();
        Object rxpm = ; // Object | Multicast, TCP, Multi-TCP, UDP
        try {
            apiInstance.decodeTransportGet(rxpm);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIDECODEApi#decodeTransportGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NDIDECODEApi;

public class NDIDECODEApiExample {

    public static void main(String[] args) {
        NDIDECODEApi apiInstance = new NDIDECODEApi();
        Object rxpm = ; // Object | Multicast, TCP, Multi-TCP, UDP
        try {
            apiInstance.decodeTransportGet(rxpm);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIDECODEApi#decodeTransportGet");
            e.printStackTrace();
        }
    }
}
Object *rxpm = ; // Multicast, TCP, Multi-TCP, UDP (optional)

NDIDECODEApi *apiInstance = [[NDIDECODEApi alloc] init];

// Retrieve NDI network settings
[apiInstance decodeTransportGetWith:rxpm
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
if (this.readyState == 4 && this.status == 200) {
  console.log(this.responseText);
 }
};
xhttp.open("GET", "http://192.168.2.197:8080/decodeTransport", true);
xhttp.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class decodeTransportGetExample
    {
        public void main()
        {

            var apiInstance = new NDIDECODEApi();
            var rxpm = new Object(); // Object | Multicast, TCP, Multi-TCP, UDP (optional) 

            try
            {
                // Retrieve NDI network settings
                apiInstance.decodeTransportGet(rxpm);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NDIDECODEApi.decodeTransportGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNDIDECODEApi();
$rxpm = ; // Object | Multicast, TCP, Multi-TCP, UDP

try {
    $api_instance->decodeTransportGet($rxpm);
} catch (Exception $e) {
    echo 'Exception when calling NDIDECODEApi->decodeTransportGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NDIDECODEApi;

my $api_instance = WWW::SwaggerClient::NDIDECODEApi->new();
my $rxpm = ; # Object | Multicast, TCP, Multi-TCP, UDP

eval { 
    $api_instance->decodeTransportGet(rxpm => $rxpm);
};
if ($@) {
    warn "Exception when calling NDIDECODEApi->decodeTransportGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NDIDECODEApi()
rxpm =  # Object | Multicast, TCP, Multi-TCP, UDP (optional)

try: 
    # Retrieve NDI network settings
    api_instance.decode_transport_get(rxpm=rxpm)
except ApiException as e:
    print("Exception when calling NDIDECODEApi->decodeTransportGet: %s\n" % e)

Parameters

Query parameters
Name Description
rxpm
Object (string)
Multicast, TCP, Multi-TCP, UDP

Responses

Status: default - Retrieve NDI network settings

Example data

Content-Type: Example Status response
{"rxpm":"TCP"}

decodeTransportPost

Set NDI network settings

This command will set NDI network settings


/decodeTransport

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json"\
-d {\"rxpm\":\"TCP\"} http://192.168.2.197:8080/decodeTransport
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NDIDECODEApi;

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

public class NDIDECODEApiExample {

    public static void main(String[] args) {
        
        NDIDECODEApi apiInstance = new NDIDECODEApi();
        Object rxpm = ; // Object | Multicast, TCP, Multi-TCP, UDP
        try {
            apiInstance.decodeTransportPost(rxpm);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIDECODEApi#decodeTransportPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NDIDECODEApi;

public class NDIDECODEApiExample {

    public static void main(String[] args) {
        NDIDECODEApi apiInstance = new NDIDECODEApi();
        Object rxpm = ; // Object | Multicast, TCP, Multi-TCP, UDP
        try {
            apiInstance.decodeTransportPost(rxpm);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIDECODEApi#decodeTransportPost");
            e.printStackTrace();
        }
    }
}
Object *rxpm = ; // Multicast, TCP, Multi-TCP, UDP (optional)

NDIDECODEApi *apiInstance = [[NDIDECODEApi alloc] init];

// Set NDI network settings
[apiInstance decodeTransportPostWith:rxpm
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhr = new XMLHttpRequest();
var url = "http://192.168.2.197:8080/decodeTransport";
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/json");
xhr.onreadystatechange = function () {
    if (xhr.readyState === 4 && xhr.status === 200) {
	  console.log(xhr.responseText);
    }
};
var data = JSON.stringify({"rxpm":"TCP"});
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class decodeTransportPostExample
    {
        public void main()
        {

            var apiInstance = new NDIDECODEApi();
            var rxpm = new Object(); // Object | Multicast, TCP, Multi-TCP, UDP (optional) 

            try
            {
                // Set NDI network settings
                apiInstance.decodeTransportPost(rxpm);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NDIDECODEApi.decodeTransportPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNDIDECODEApi();
$rxpm = ; // Object | Multicast, TCP, Multi-TCP, UDP

try {
    $api_instance->decodeTransportPost($rxpm);
} catch (Exception $e) {
    echo 'Exception when calling NDIDECODEApi->decodeTransportPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NDIDECODEApi;

my $api_instance = WWW::SwaggerClient::NDIDECODEApi->new();
my $rxpm = ; # Object | Multicast, TCP, Multi-TCP, UDP

eval { 
    $api_instance->decodeTransportPost(rxpm => $rxpm);
};
if ($@) {
    warn "Exception when calling NDIDECODEApi->decodeTransportPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NDIDECODEApi()
rxpm =  # Object | Multicast, TCP, Multi-TCP, UDP (optional)

try: 
    # Set NDI network settings
    api_instance.decode_transport_post(rxpm=rxpm)
except ApiException as e:
    print("Exception when calling NDIDECODEApi->decodeTransportPost: %s\n" % e)

Parameters

Query parameters
Name Description
rxpm
Object (string)
Multicast, TCP, Multi-TCP, UDP

Responses

Status: default - Set NDI network settings

Example data

Content-Type: Example Status response
{"rxpm":"TCP"}

decodesetupGet

Retrieve Decode Settings

This command will fetch current decode settings


/decodesetup

Usage and SDK Samples

curl -X GET\
-H "Accept: text"\
"http://192.168.2.197:8080/decodesetup?ChNum=&ColorSpace=&TallyMode=&ScreenSaverMode=&NDIAudio="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NDIDECODEApi;

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

public class NDIDECODEApiExample {

    public static void main(String[] args) {
        
        NDIDECODEApi apiInstance = new NDIDECODEApi();
        Object chNum = ; // Object | Channel No. Range 1 to 4
        Object colorSpace = ; // Object | RGB, YUV
        Object tallyMode = ; // Object | TallyOn, TallyOff, VideoMode
        Object screenSaverMode = ; // Object | BirdDogSS, BlackSS, CaptureSS
        Object nDIAudio = ; // Object | NDIAudioEn, NDIAudioDis
        try {
            apiInstance.decodesetupGet(chNum, colorSpace, tallyMode, screenSaverMode, nDIAudio);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIDECODEApi#decodesetupGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NDIDECODEApi;

public class NDIDECODEApiExample {

    public static void main(String[] args) {
        NDIDECODEApi apiInstance = new NDIDECODEApi();
        Object chNum = ; // Object | Channel No. Range 1 to 4
        Object colorSpace = ; // Object | RGB, YUV
        Object tallyMode = ; // Object | TallyOn, TallyOff, VideoMode
        Object screenSaverMode = ; // Object | BirdDogSS, BlackSS, CaptureSS
        Object nDIAudio = ; // Object | NDIAudioEn, NDIAudioDis
        try {
            apiInstance.decodesetupGet(chNum, colorSpace, tallyMode, screenSaverMode, nDIAudio);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIDECODEApi#decodesetupGet");
            e.printStackTrace();
        }
    }
}
Object *chNum = ; // Channel No. Range 1 to 4 (optional)
Object *colorSpace = ; // RGB, YUV (optional)
Object *tallyMode = ; // TallyOn, TallyOff, VideoMode (optional)
Object *screenSaverMode = ; // BirdDogSS, BlackSS, CaptureSS (optional)
Object *nDIAudio = ; // NDIAudioEn, NDIAudioDis (optional)

NDIDECODEApi *apiInstance = [[NDIDECODEApi alloc] init];

// Retrieve Decode Settings
[apiInstance decodesetupGetWith:chNum
    colorSpace:colorSpace
    tallyMode:tallyMode
    screenSaverMode:screenSaverMode
    nDIAudio:nDIAudio
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
if (this.readyState == 4 && this.status == 200) {
  console.log(this.responseText);
 }
};
xhttp.open("GET", "http://192.168.2.197:8080/decodesetup", true);
xhttp.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class decodesetupGetExample
    {
        public void main()
        {

            var apiInstance = new NDIDECODEApi();
            var chNum = new Object(); // Object | Channel No. Range 1 to 4 (optional) 
            var colorSpace = new Object(); // Object | RGB, YUV (optional) 
            var tallyMode = new Object(); // Object | TallyOn, TallyOff, VideoMode (optional) 
            var screenSaverMode = new Object(); // Object | BirdDogSS, BlackSS, CaptureSS (optional) 
            var nDIAudio = new Object(); // Object | NDIAudioEn, NDIAudioDis (optional) 

            try
            {
                // Retrieve Decode Settings
                apiInstance.decodesetupGet(chNum, colorSpace, tallyMode, screenSaverMode, nDIAudio);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NDIDECODEApi.decodesetupGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNDIDECODEApi();
$chNum = ; // Object | Channel No. Range 1 to 4
$colorSpace = ; // Object | RGB, YUV
$tallyMode = ; // Object | TallyOn, TallyOff, VideoMode
$screenSaverMode = ; // Object | BirdDogSS, BlackSS, CaptureSS
$nDIAudio = ; // Object | NDIAudioEn, NDIAudioDis

try {
    $api_instance->decodesetupGet($chNum, $colorSpace, $tallyMode, $screenSaverMode, $nDIAudio);
} catch (Exception $e) {
    echo 'Exception when calling NDIDECODEApi->decodesetupGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NDIDECODEApi;

my $api_instance = WWW::SwaggerClient::NDIDECODEApi->new();
my $chNum = ; # Object | Channel No. Range 1 to 4
my $colorSpace = ; # Object | RGB, YUV
my $tallyMode = ; # Object | TallyOn, TallyOff, VideoMode
my $screenSaverMode = ; # Object | BirdDogSS, BlackSS, CaptureSS
my $nDIAudio = ; # Object | NDIAudioEn, NDIAudioDis

eval { 
    $api_instance->decodesetupGet(chNum => $chNum, colorSpace => $colorSpace, tallyMode => $tallyMode, screenSaverMode => $screenSaverMode, nDIAudio => $nDIAudio);
};
if ($@) {
    warn "Exception when calling NDIDECODEApi->decodesetupGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NDIDECODEApi()
chNum =  # Object | Channel No. Range 1 to 4 (optional)
colorSpace =  # Object | RGB, YUV (optional)
tallyMode =  # Object | TallyOn, TallyOff, VideoMode (optional)
screenSaverMode =  # Object | BirdDogSS, BlackSS, CaptureSS (optional)
nDIAudio =  # Object | NDIAudioEn, NDIAudioDis (optional)

try: 
    # Retrieve Decode Settings
    api_instance.decodesetup_get(chNum=chNum, colorSpace=colorSpace, tallyMode=tallyMode, screenSaverMode=screenSaverMode, nDIAudio=nDIAudio)
except ApiException as e:
    print("Exception when calling NDIDECODEApi->decodesetupGet: %s\n" % e)

Parameters

Query parameters
Name Description
ChNum
Object (string)
Channel No. Range 1 to 4
ColorSpace
Object (string)
RGB, YUV
TallyMode
Object (string)
TallyOn, TallyOff, VideoMode
ScreenSaverMode
Object (string)
BirdDogSS, BlackSS, CaptureSS
NDIAudio
Object (string)
NDIAudioEn, NDIAudioDis

Responses

Status: default - Current Decode Settings

Example data

Content-Type: Example Status response
{"ColorSpace":"RGB","NDIAudio":"NDIAudioEn","ScreenSaverMode":"BirdDogSS","TallyMode":"VideoMode","ChNum":"1"}

decodesetupPost

Set Decode Settings

This command sets decode settings


/decodesetup

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json"\
-d {\"ColorSpace\":\"RGB\",\"NDIAudio\":\"NDIAudioEn\",\"ScreenSaverMode\":\"BirdDogSS\",\"TallyMode\":\"VideoMode\",\"ChNum\":\"1\"} http://192.168.2.197:8080/decodesetup
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NDIDECODEApi;

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

public class NDIDECODEApiExample {

    public static void main(String[] args) {
        
        NDIDECODEApi apiInstance = new NDIDECODEApi();
        Object chNum = ; // Object | Channel No. Range 1 to 4
        Object colorSpace = ; // Object | RGB, YUV
        Object tallyMode = ; // Object | TallyOn, TallyOff, VideoMode
        Object screenSaverMode = ; // Object | BirdDogSS, BlackSS, CaptureSS
        Object nDIAudio = ; // Object | NDIAudioEn, NDIAudioDis
        try {
            apiInstance.decodesetupPost(chNum, colorSpace, tallyMode, screenSaverMode, nDIAudio);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIDECODEApi#decodesetupPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NDIDECODEApi;

public class NDIDECODEApiExample {

    public static void main(String[] args) {
        NDIDECODEApi apiInstance = new NDIDECODEApi();
        Object chNum = ; // Object | Channel No. Range 1 to 4
        Object colorSpace = ; // Object | RGB, YUV
        Object tallyMode = ; // Object | TallyOn, TallyOff, VideoMode
        Object screenSaverMode = ; // Object | BirdDogSS, BlackSS, CaptureSS
        Object nDIAudio = ; // Object | NDIAudioEn, NDIAudioDis
        try {
            apiInstance.decodesetupPost(chNum, colorSpace, tallyMode, screenSaverMode, nDIAudio);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIDECODEApi#decodesetupPost");
            e.printStackTrace();
        }
    }
}
Object *chNum = ; // Channel No. Range 1 to 4 (optional)
Object *colorSpace = ; // RGB, YUV (optional)
Object *tallyMode = ; // TallyOn, TallyOff, VideoMode (optional)
Object *screenSaverMode = ; // BirdDogSS, BlackSS, CaptureSS (optional)
Object *nDIAudio = ; // NDIAudioEn, NDIAudioDis (optional)

NDIDECODEApi *apiInstance = [[NDIDECODEApi alloc] init];

// Set Decode Settings
[apiInstance decodesetupPostWith:chNum
    colorSpace:colorSpace
    tallyMode:tallyMode
    screenSaverMode:screenSaverMode
    nDIAudio:nDIAudio
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhr = new XMLHttpRequest();
var url = "http://192.168.2.197:8080/decodesetup";
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/json");
xhr.onreadystatechange = function () {
    if (xhr.readyState === 4 && xhr.status === 200) {
	  console.log(xhr.responseText);
    }
};
var data = JSON.stringify({"ColorSpace":"RGB","NDIAudio":"NDIAudioEn","ScreenSaverMode":"BirdDogSS","TallyMode":"VideoMode","ChNum":"1"});
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class decodesetupPostExample
    {
        public void main()
        {

            var apiInstance = new NDIDECODEApi();
            var chNum = new Object(); // Object | Channel No. Range 1 to 4 (optional) 
            var colorSpace = new Object(); // Object | RGB, YUV (optional) 
            var tallyMode = new Object(); // Object | TallyOn, TallyOff, VideoMode (optional) 
            var screenSaverMode = new Object(); // Object | BirdDogSS, BlackSS, CaptureSS (optional) 
            var nDIAudio = new Object(); // Object | NDIAudioEn, NDIAudioDis (optional) 

            try
            {
                // Set Decode Settings
                apiInstance.decodesetupPost(chNum, colorSpace, tallyMode, screenSaverMode, nDIAudio);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NDIDECODEApi.decodesetupPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNDIDECODEApi();
$chNum = ; // Object | Channel No. Range 1 to 4
$colorSpace = ; // Object | RGB, YUV
$tallyMode = ; // Object | TallyOn, TallyOff, VideoMode
$screenSaverMode = ; // Object | BirdDogSS, BlackSS, CaptureSS
$nDIAudio = ; // Object | NDIAudioEn, NDIAudioDis

try {
    $api_instance->decodesetupPost($chNum, $colorSpace, $tallyMode, $screenSaverMode, $nDIAudio);
} catch (Exception $e) {
    echo 'Exception when calling NDIDECODEApi->decodesetupPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NDIDECODEApi;

my $api_instance = WWW::SwaggerClient::NDIDECODEApi->new();
my $chNum = ; # Object | Channel No. Range 1 to 4
my $colorSpace = ; # Object | RGB, YUV
my $tallyMode = ; # Object | TallyOn, TallyOff, VideoMode
my $screenSaverMode = ; # Object | BirdDogSS, BlackSS, CaptureSS
my $nDIAudio = ; # Object | NDIAudioEn, NDIAudioDis

eval { 
    $api_instance->decodesetupPost(chNum => $chNum, colorSpace => $colorSpace, tallyMode => $tallyMode, screenSaverMode => $screenSaverMode, nDIAudio => $nDIAudio);
};
if ($@) {
    warn "Exception when calling NDIDECODEApi->decodesetupPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NDIDECODEApi()
chNum =  # Object | Channel No. Range 1 to 4 (optional)
colorSpace =  # Object | RGB, YUV (optional)
tallyMode =  # Object | TallyOn, TallyOff, VideoMode (optional)
screenSaverMode =  # Object | BirdDogSS, BlackSS, CaptureSS (optional)
nDIAudio =  # Object | NDIAudioEn, NDIAudioDis (optional)

try: 
    # Set Decode Settings
    api_instance.decodesetup_post(chNum=chNum, colorSpace=colorSpace, tallyMode=tallyMode, screenSaverMode=screenSaverMode, nDIAudio=nDIAudio)
except ApiException as e:
    print("Exception when calling NDIDECODEApi->decodesetupPost: %s\n" % e)

Parameters

Query parameters
Name Description
ChNum
Object (string)
Channel No. Range 1 to 4
ColorSpace
Object (string)
RGB, YUV
TallyMode
Object (string)
TallyOn, TallyOff, VideoMode
ScreenSaverMode
Object (string)
BirdDogSS, BlackSS, CaptureSS
NDIAudio
Object (string)
NDIAudioEn, NDIAudioDis

Responses

Status: default - Current Decode Settings

Example data

Content-Type: Example Status response
{"ColorSpace":"RGB","NDIAudio":"NDIAudioEn","ScreenSaverMode":"BirdDogSS","TallyMode":"VideoMode","ChNum":"1"}

decodestatusGet

Retrieve connected NDI Source Status

This shows you connected NDI Source Status


/decodestatus

Usage and SDK Samples

curl -X GET\
-H "Accept: text"\
"http://192.168.2.197:8080/decodestatus?ChNum="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NDIDECODEApi;

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

public class NDIDECODEApiExample {

    public static void main(String[] args) {
        
        NDIDECODEApi apiInstance = new NDIDECODEApi();
        Object chNum = ; // Object | Channel No. Range 1 to 4
        try {
            apiInstance.decodestatusGet(chNum);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIDECODEApi#decodestatusGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NDIDECODEApi;

public class NDIDECODEApiExample {

    public static void main(String[] args) {
        NDIDECODEApi apiInstance = new NDIDECODEApi();
        Object chNum = ; // Object | Channel No. Range 1 to 4
        try {
            apiInstance.decodestatusGet(chNum);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIDECODEApi#decodestatusGet");
            e.printStackTrace();
        }
    }
}
Object *chNum = ; // Channel No. Range 1 to 4 (optional)

NDIDECODEApi *apiInstance = [[NDIDECODEApi alloc] init];

// Retrieve connected NDI Source Status
[apiInstance decodestatusGetWith:chNum
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
if (this.readyState == 4 && this.status == 200) {
  console.log(this.responseText);
 }
};
xhttp.open("GET", "http://192.168.2.197:8080/decodestatus", true);
xhttp.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class decodestatusGetExample
    {
        public void main()
        {

            var apiInstance = new NDIDECODEApi();
            var chNum = new Object(); // Object | Channel No. Range 1 to 4 (optional) 

            try
            {
                // Retrieve connected NDI Source Status
                apiInstance.decodestatusGet(chNum);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NDIDECODEApi.decodestatusGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNDIDECODEApi();
$chNum = ; // Object | Channel No. Range 1 to 4

try {
    $api_instance->decodestatusGet($chNum);
} catch (Exception $e) {
    echo 'Exception when calling NDIDECODEApi->decodestatusGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NDIDECODEApi;

my $api_instance = WWW::SwaggerClient::NDIDECODEApi->new();
my $chNum = ; # Object | Channel No. Range 1 to 4

eval { 
    $api_instance->decodestatusGet(chNum => $chNum);
};
if ($@) {
    warn "Exception when calling NDIDECODEApi->decodestatusGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NDIDECODEApi()
chNum =  # Object | Channel No. Range 1 to 4 (optional)

try: 
    # Retrieve connected NDI Source Status
    api_instance.decodestatus_get(chNum=chNum)
except ApiException as e:
    print("Exception when calling NDIDECODEApi->decodestatusGet: %s\n" % e)

Parameters

Query parameters
Name Description
ChNum
Object (string)
Channel No. Range 1 to 4

Responses

Status: default - Current connected NDI Source Status

Example data

Content-Type: Example Status response
{"Videoresolution":"0x0","VideoFramerate":"0p","VideoSamplerate":"0:0:0","Audiochannels":"0","AudioSamplerate":"0","AverageBitrate":"0"}

NDIFINDER

listGet

Retrieve List of active NDI Sources on the Network

This command will get the list of active NDI Sources on the Network


/List

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://192.168.2.197:8080/List"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NDIFINDERApi;

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

public class NDIFINDERApiExample {

    public static void main(String[] args) {
        
        NDIFINDERApi apiInstance = new NDIFINDERApi();
        try {
            apiInstance.listGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIFINDERApi#listGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NDIFINDERApi;

public class NDIFINDERApiExample {

    public static void main(String[] args) {
        NDIFINDERApi apiInstance = new NDIFINDERApi();
        try {
            apiInstance.listGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIFINDERApi#listGet");
            e.printStackTrace();
        }
    }
}

NDIFINDERApi *apiInstance = [[NDIFINDERApi alloc] init];

// Retrieve List of active NDI Sources on the Network
[apiInstance listGetWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
if (this.readyState == 4 && this.status == 200) {
  console.log(this.responseText);
 }
};
xhttp.open("GET", "http://192.168.2.197:8080/List", true);
xhttp.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listGetExample
    {
        public void main()
        {

            var apiInstance = new NDIFINDERApi();

            try
            {
                // Retrieve List of active NDI Sources on the Network
                apiInstance.listGet();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NDIFINDERApi.listGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNDIFINDERApi();

try {
    $api_instance->listGet();
} catch (Exception $e) {
    echo 'Exception when calling NDIFINDERApi->listGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NDIFINDERApi;

my $api_instance = WWW::SwaggerClient::NDIFINDERApi->new();

eval { 
    $api_instance->listGet();
};
if ($@) {
    warn "Exception when calling NDIFINDERApi->listGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NDIFINDERApi()

try: 
    # Retrieve List of active NDI Sources on the Network
    api_instance.list_get()
except ApiException as e:
    print("Exception when calling NDIFINDERApi->listGet: %s\n" % e)

Parameters

Responses

Status: default - List of active NDI Sources on the Network

Example data

Content-Type: Example Status response
{"None":"None"}

NDIDisServerGet

Retrieve NDI Discovery server info

This command will get NDI Discovery server info


/NDIDisServer

Usage and SDK Samples

curl -X GET\
-H "Accept: text"\
"http://192.168.2.197:8080/NDIDisServer?NDIDisServ=&NDIDisServIP="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NDIFINDERApi;

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

public class NDIFINDERApiExample {

    public static void main(String[] args) {
        
        NDIFINDERApi apiInstance = new NDIFINDERApi();
        Object nDIDisServ = ; // Object | NDIDisServEn/NDIDisServDis
        Object nDIDisServIP = ; // Object | xxx.xxx.xxx.xxx
        try {
            apiInstance.nDIDisServerGet(nDIDisServ, nDIDisServIP);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIFINDERApi#nDIDisServerGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NDIFINDERApi;

public class NDIFINDERApiExample {

    public static void main(String[] args) {
        NDIFINDERApi apiInstance = new NDIFINDERApi();
        Object nDIDisServ = ; // Object | NDIDisServEn/NDIDisServDis
        Object nDIDisServIP = ; // Object | xxx.xxx.xxx.xxx
        try {
            apiInstance.nDIDisServerGet(nDIDisServ, nDIDisServIP);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIFINDERApi#nDIDisServerGet");
            e.printStackTrace();
        }
    }
}
Object *nDIDisServ = ; // NDIDisServEn/NDIDisServDis (optional)
Object *nDIDisServIP = ; // xxx.xxx.xxx.xxx (optional)

NDIFINDERApi *apiInstance = [[NDIFINDERApi alloc] init];

// Retrieve NDI Discovery server info
[apiInstance nDIDisServerGetWith:nDIDisServ
    nDIDisServIP:nDIDisServIP
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
if (this.readyState == 4 && this.status == 200) {
  console.log(this.responseText);
 }
};
xhttp.open("GET", "http://192.168.2.197:8080/NDIDisServer", true);
xhttp.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class nDIDisServerGetExample
    {
        public void main()
        {

            var apiInstance = new NDIFINDERApi();
            var nDIDisServ = new Object(); // Object | NDIDisServEn/NDIDisServDis (optional) 
            var nDIDisServIP = new Object(); // Object | xxx.xxx.xxx.xxx (optional) 

            try
            {
                // Retrieve NDI Discovery server info
                apiInstance.nDIDisServerGet(nDIDisServ, nDIDisServIP);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NDIFINDERApi.nDIDisServerGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNDIFINDERApi();
$nDIDisServ = ; // Object | NDIDisServEn/NDIDisServDis
$nDIDisServIP = ; // Object | xxx.xxx.xxx.xxx

try {
    $api_instance->nDIDisServerGet($nDIDisServ, $nDIDisServIP);
} catch (Exception $e) {
    echo 'Exception when calling NDIFINDERApi->nDIDisServerGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NDIFINDERApi;

my $api_instance = WWW::SwaggerClient::NDIFINDERApi->new();
my $nDIDisServ = ; # Object | NDIDisServEn/NDIDisServDis
my $nDIDisServIP = ; # Object | xxx.xxx.xxx.xxx

eval { 
    $api_instance->nDIDisServerGet(nDIDisServ => $nDIDisServ, nDIDisServIP => $nDIDisServIP);
};
if ($@) {
    warn "Exception when calling NDIFINDERApi->nDIDisServerGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NDIFINDERApi()
nDIDisServ =  # Object | NDIDisServEn/NDIDisServDis (optional)
nDIDisServIP =  # Object | xxx.xxx.xxx.xxx (optional)

try: 
    # Retrieve NDI Discovery server info
    api_instance.n_di_dis_server_get(nDIDisServ=nDIDisServ, nDIDisServIP=nDIDisServIP)
except ApiException as e:
    print("Exception when calling NDIFINDERApi->nDIDisServerGet: %s\n" % e)

Parameters

Query parameters
Name Description
NDIDisServ
Object (string)
NDIDisServEn/NDIDisServDis
NDIDisServIP
Object (string)
xxx.xxx.xxx.xxx

Responses

Status: default - Retrieve NDI Discovery server info

Example data

Content-Type: Example Status response
{"NDIDisServ":"NDIDisServEn","NDIDisServIP":"xxx.xxx.xxx.xxx"}

NDIDisServerPost

Set NDI Discovery server info

This command will set NDI Discovery server info


/NDIDisServer

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json"\
-d {\"NDIDisServ\":\"NDIDisServEn\",\"NDIDisServIP\":\"xxx.xxx.xxx.xxx\"} http://192.168.2.197:8080/NDIDisServer
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NDIFINDERApi;

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

public class NDIFINDERApiExample {

    public static void main(String[] args) {
        
        NDIFINDERApi apiInstance = new NDIFINDERApi();
        Object nDIDisServ = ; // Object | NDIDisServEn/NDIDisServDis
        Object nDIDisServIP = ; // Object | xxx.xxx.xxx.xxx
        try {
            apiInstance.nDIDisServerPost(nDIDisServ, nDIDisServIP);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIFINDERApi#nDIDisServerPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NDIFINDERApi;

public class NDIFINDERApiExample {

    public static void main(String[] args) {
        NDIFINDERApi apiInstance = new NDIFINDERApi();
        Object nDIDisServ = ; // Object | NDIDisServEn/NDIDisServDis
        Object nDIDisServIP = ; // Object | xxx.xxx.xxx.xxx
        try {
            apiInstance.nDIDisServerPost(nDIDisServ, nDIDisServIP);
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIFINDERApi#nDIDisServerPost");
            e.printStackTrace();
        }
    }
}
Object *nDIDisServ = ; // NDIDisServEn/NDIDisServDis (optional)
Object *nDIDisServIP = ; // xxx.xxx.xxx.xxx (optional)

NDIFINDERApi *apiInstance = [[NDIFINDERApi alloc] init];

// Set NDI Discovery server info
[apiInstance nDIDisServerPostWith:nDIDisServ
    nDIDisServIP:nDIDisServIP
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhr = new XMLHttpRequest();
var url = "http://192.168.2.197:8080/NDIDisServer";
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/json");
xhr.onreadystatechange = function () {
    if (xhr.readyState === 4 && xhr.status === 200) {
	  console.log(xhr.responseText);
    }
};
var data = JSON.stringify({"NDIDisServ":"NDIDisServEn","NDIDisServIP":"xxx.xxx.xxx.xxx"});
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class nDIDisServerPostExample
    {
        public void main()
        {

            var apiInstance = new NDIFINDERApi();
            var nDIDisServ = new Object(); // Object | NDIDisServEn/NDIDisServDis (optional) 
            var nDIDisServIP = new Object(); // Object | xxx.xxx.xxx.xxx (optional) 

            try
            {
                // Set NDI Discovery server info
                apiInstance.nDIDisServerPost(nDIDisServ, nDIDisServIP);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NDIFINDERApi.nDIDisServerPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNDIFINDERApi();
$nDIDisServ = ; // Object | NDIDisServEn/NDIDisServDis
$nDIDisServIP = ; // Object | xxx.xxx.xxx.xxx

try {
    $api_instance->nDIDisServerPost($nDIDisServ, $nDIDisServIP);
} catch (Exception $e) {
    echo 'Exception when calling NDIFINDERApi->nDIDisServerPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NDIFINDERApi;

my $api_instance = WWW::SwaggerClient::NDIFINDERApi->new();
my $nDIDisServ = ; # Object | NDIDisServEn/NDIDisServDis
my $nDIDisServIP = ; # Object | xxx.xxx.xxx.xxx

eval { 
    $api_instance->nDIDisServerPost(nDIDisServ => $nDIDisServ, nDIDisServIP => $nDIDisServIP);
};
if ($@) {
    warn "Exception when calling NDIFINDERApi->nDIDisServerPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NDIFINDERApi()
nDIDisServ =  # Object | NDIDisServEn/NDIDisServDis (optional)
nDIDisServIP =  # Object | xxx.xxx.xxx.xxx (optional)

try: 
    # Set NDI Discovery server info
    api_instance.n_di_dis_server_post(nDIDisServ=nDIDisServ, nDIDisServIP=nDIDisServIP)
except ApiException as e:
    print("Exception when calling NDIFINDERApi->nDIDisServerPost: %s\n" % e)

Parameters

Query parameters
Name Description
NDIDisServ
Object (string)
NDIDisServEn/NDIDisServDis
NDIDisServIP
Object (string)
xxx.xxx.xxx.xxx

Responses

Status: default - Set NDI Discovery server info

Example data

Content-Type: Example Status response
{"NDIDisServ":"NDIDisServEn","NDIDisServIP":"xxx.xxx.xxx.xxx"}

NDIGrpNameGet

Retrieve GroupName

This command will return Group Name


/NDIGrpName

Usage and SDK Samples

curl -X GET\
-H "Accept: text"\
"http://192.168.2.197:8080/NDIGrpName"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NDIFINDERApi;

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

public class NDIFINDERApiExample {

    public static void main(String[] args) {
        
        NDIFINDERApi apiInstance = new NDIFINDERApi();
        try {
            apiInstance.nDIGrpNameGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIFINDERApi#nDIGrpNameGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NDIFINDERApi;

public class NDIFINDERApiExample {

    public static void main(String[] args) {
        NDIFINDERApi apiInstance = new NDIFINDERApi();
        try {
            apiInstance.nDIGrpNameGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIFINDERApi#nDIGrpNameGet");
            e.printStackTrace();
        }
    }
}

NDIFINDERApi *apiInstance = [[NDIFINDERApi alloc] init];

// Retrieve GroupName
[apiInstance nDIGrpNameGetWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
if (this.readyState == 4 && this.status == 200) {
  console.log(this.responseText);
 }
};
xhttp.open("GET", "http://192.168.2.197:8080/NDIGrpName", true);
xhttp.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class nDIGrpNameGetExample
    {
        public void main()
        {

            var apiInstance = new NDIFINDERApi();

            try
            {
                // Retrieve GroupName
                apiInstance.nDIGrpNameGet();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NDIFINDERApi.nDIGrpNameGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNDIFINDERApi();

try {
    $api_instance->nDIGrpNameGet();
} catch (Exception $e) {
    echo 'Exception when calling NDIFINDERApi->nDIGrpNameGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NDIFINDERApi;

my $api_instance = WWW::SwaggerClient::NDIFINDERApi->new();

eval { 
    $api_instance->nDIGrpNameGet();
};
if ($@) {
    warn "Exception when calling NDIFINDERApi->nDIGrpNameGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NDIFINDERApi()

try: 
    # Retrieve GroupName
    api_instance.n_di_grp_name_get()
except ApiException as e:
    print("Exception when calling NDIFINDERApi->nDIGrpNameGet: %s\n" % e)

Parameters

Responses

Status: default - Return Group Name

Example data

Content-Type: Example Status response
BirdDogxxx

NDIGrpNamePost

Set GroupName

This command will set Group Name


/NDIGrpName

Usage and SDK Samples

curl -X POST\
-H "Content-Type: text/plain"\
-d "BirdDogxxx" http://192.168.2.197:8080/NdiGrpName
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NDIFINDERApi;

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

public class NDIFINDERApiExample {

    public static void main(String[] args) {
        
        NDIFINDERApi apiInstance = new NDIFINDERApi();
        try {
            apiInstance.nDIGrpNamePost();
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIFINDERApi#nDIGrpNamePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NDIFINDERApi;

public class NDIFINDERApiExample {

    public static void main(String[] args) {
        NDIFINDERApi apiInstance = new NDIFINDERApi();
        try {
            apiInstance.nDIGrpNamePost();
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIFINDERApi#nDIGrpNamePost");
            e.printStackTrace();
        }
    }
}

NDIFINDERApi *apiInstance = [[NDIFINDERApi alloc] init];

// Set GroupName
[apiInstance nDIGrpNamePostWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhr = new XMLHttpRequest();
var url = "http://192.168.2.197:8080/NDIGrpName";
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "text/plain");
xhr.onreadystatechange = function () {
    if (xhr.readyState === 4 && xhr.status === 200) {
	  console.log(xhr.responseText);
    }
};
var data = "BirdDogxxx";
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class nDIGrpNamePostExample
    {
        public void main()
        {

            var apiInstance = new NDIFINDERApi();

            try
            {
                // Set GroupName
                apiInstance.nDIGrpNamePost();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NDIFINDERApi.nDIGrpNamePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNDIFINDERApi();

try {
    $api_instance->nDIGrpNamePost();
} catch (Exception $e) {
    echo 'Exception when calling NDIFINDERApi->nDIGrpNamePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NDIFINDERApi;

my $api_instance = WWW::SwaggerClient::NDIFINDERApi->new();

eval { 
    $api_instance->nDIGrpNamePost();
};
if ($@) {
    warn "Exception when calling NDIFINDERApi->nDIGrpNamePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NDIFINDERApi()

try: 
    # Set GroupName
    api_instance.n_di_grp_name_post()
except ApiException as e:
    print("Exception when calling NDIFINDERApi->nDIGrpNamePost: %s\n" % e)

Parameters

Responses

Status: default - Set Group Name

Example data

Content-Type: Example Status response
BirdDogxxx

NDIOffSnSrcGet

Retrieve Off Subnet IP List

This command will return Off Subnet IP List


/NDIOffSnSrc

Usage and SDK Samples

curl -X GET\
-H "Accept: text"\
"http://192.168.2.197:8080/NDIOffSnSrc"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NDIFINDERApi;

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

public class NDIFINDERApiExample {

    public static void main(String[] args) {
        
        NDIFINDERApi apiInstance = new NDIFINDERApi();
        try {
            apiInstance.nDIOffSnSrcGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIFINDERApi#nDIOffSnSrcGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NDIFINDERApi;

public class NDIFINDERApiExample {

    public static void main(String[] args) {
        NDIFINDERApi apiInstance = new NDIFINDERApi();
        try {
            apiInstance.nDIOffSnSrcGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIFINDERApi#nDIOffSnSrcGet");
            e.printStackTrace();
        }
    }
}

NDIFINDERApi *apiInstance = [[NDIFINDERApi alloc] init];

// Retrieve Off Subnet IP List
[apiInstance nDIOffSnSrcGetWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
if (this.readyState == 4 && this.status == 200) {
  console.log(this.responseText);
 }
};
xhttp.open("GET", "http://192.168.2.197:8080/NDIOffSnSrc", true);
xhttp.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class nDIOffSnSrcGetExample
    {
        public void main()
        {

            var apiInstance = new NDIFINDERApi();

            try
            {
                // Retrieve Off Subnet IP List
                apiInstance.nDIOffSnSrcGet();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NDIFINDERApi.nDIOffSnSrcGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNDIFINDERApi();

try {
    $api_instance->nDIOffSnSrcGet();
} catch (Exception $e) {
    echo 'Exception when calling NDIFINDERApi->nDIOffSnSrcGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NDIFINDERApi;

my $api_instance = WWW::SwaggerClient::NDIFINDERApi->new();

eval { 
    $api_instance->nDIOffSnSrcGet();
};
if ($@) {
    warn "Exception when calling NDIFINDERApi->nDIOffSnSrcGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NDIFINDERApi()

try: 
    # Retrieve Off Subnet IP List
    api_instance.n_di_off_sn_src_get()
except ApiException as e:
    print("Exception when calling NDIFINDERApi->nDIOffSnSrcGet: %s\n" % e)

Parameters

Responses

Status: default - Off Subnet IP List

Example data

Content-Type: Example Status response
xxx.xxx.xxx.xxx

NDIOffSnSrcPost

Set Off Subnet IP

This command will set Off Subnet IP


/NDIOffSnSrc

Usage and SDK Samples

curl -X POST\
-H "Content-Type: text/plain"\
-d "xxx.xxx.xxx.xxx" http://192.168.2.197:8080/NdiOffSnSrc
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NDIFINDERApi;

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

public class NDIFINDERApiExample {

    public static void main(String[] args) {
        
        NDIFINDERApi apiInstance = new NDIFINDERApi();
        try {
            apiInstance.nDIOffSnSrcPost();
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIFINDERApi#nDIOffSnSrcPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NDIFINDERApi;

public class NDIFINDERApiExample {

    public static void main(String[] args) {
        NDIFINDERApi apiInstance = new NDIFINDERApi();
        try {
            apiInstance.nDIOffSnSrcPost();
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIFINDERApi#nDIOffSnSrcPost");
            e.printStackTrace();
        }
    }
}

NDIFINDERApi *apiInstance = [[NDIFINDERApi alloc] init];

// Set Off Subnet IP
[apiInstance nDIOffSnSrcPostWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhr = new XMLHttpRequest();
var url = "http://192.168.2.197:8080/NDIOffSnSrc";
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "text/plain");
xhr.onreadystatechange = function () {
    if (xhr.readyState === 4 && xhr.status === 200) {
	  console.log(xhr.responseText);
    }
};
var data = "xxx.xxx.xxx.xxx";
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class nDIOffSnSrcPostExample
    {
        public void main()
        {

            var apiInstance = new NDIFINDERApi();

            try
            {
                // Set Off Subnet IP
                apiInstance.nDIOffSnSrcPost();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NDIFINDERApi.nDIOffSnSrcPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNDIFINDERApi();

try {
    $api_instance->nDIOffSnSrcPost();
} catch (Exception $e) {
    echo 'Exception when calling NDIFINDERApi->nDIOffSnSrcPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NDIFINDERApi;

my $api_instance = WWW::SwaggerClient::NDIFINDERApi->new();

eval { 
    $api_instance->nDIOffSnSrcPost();
};
if ($@) {
    warn "Exception when calling NDIFINDERApi->nDIOffSnSrcPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NDIFINDERApi()

try: 
    # Set Off Subnet IP
    api_instance.n_di_off_sn_src_post()
except ApiException as e:
    print("Exception when calling NDIFINDERApi->nDIOffSnSrcPost: %s\n" % e)

Parameters

Responses

Status: default - Set Off Subnet IP

Example data

Content-Type: Example Status response
xxx.xxx.xxx.xxx

refreshGet

Refresh NDI Source List

This command will immediately refresh NDI Source List.


/refresh

Usage and SDK Samples

curl -X GET\
-H "Accept: text"\
"http://192.168.2.197:8080/refresh"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NDIFINDERApi;

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

public class NDIFINDERApiExample {

    public static void main(String[] args) {
        
        NDIFINDERApi apiInstance = new NDIFINDERApi();
        try {
            apiInstance.refreshGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIFINDERApi#refreshGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NDIFINDERApi;

public class NDIFINDERApiExample {

    public static void main(String[] args) {
        NDIFINDERApi apiInstance = new NDIFINDERApi();
        try {
            apiInstance.refreshGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIFINDERApi#refreshGet");
            e.printStackTrace();
        }
    }
}

NDIFINDERApi *apiInstance = [[NDIFINDERApi alloc] init];

// Refresh NDI Source List
[apiInstance refreshGetWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
if (this.readyState == 4 && this.status == 200) {
  console.log(this.responseText);
 }
};
xhttp.open("GET", "http://192.168.2.197:8080/refresh", true);
xhttp.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class refreshGetExample
    {
        public void main()
        {

            var apiInstance = new NDIFINDERApi();

            try
            {
                // Refresh NDI Source List
                apiInstance.refreshGet();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NDIFINDERApi.refreshGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNDIFINDERApi();

try {
    $api_instance->refreshGet();
} catch (Exception $e) {
    echo 'Exception when calling NDIFINDERApi->refreshGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NDIFINDERApi;

my $api_instance = WWW::SwaggerClient::NDIFINDERApi->new();

eval { 
    $api_instance->refreshGet();
};
if ($@) {
    warn "Exception when calling NDIFINDERApi->refreshGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NDIFINDERApi()

try: 
    # Refresh NDI Source List
    api_instance.refresh_get()
except ApiException as e:
    print("Exception when calling NDIFINDERApi->refreshGet: %s\n" % e)

Parameters

Responses

Status: default - Immediately all the sources on the network will be visible

Example data

Content-Type: Example Status response
{}

refreshPost

Refresh NDI Source List

This command will immediately refresh NDI Source List.


/refresh

Usage and SDK Samples

curl -X POST\
-H "Accept: text"\
"http://192.168.2.197:8080/refresh"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NDIFINDERApi;

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

public class NDIFINDERApiExample {

    public static void main(String[] args) {
        
        NDIFINDERApi apiInstance = new NDIFINDERApi();
        try {
            apiInstance.refreshPost();
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIFINDERApi#refreshPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NDIFINDERApi;

public class NDIFINDERApiExample {

    public static void main(String[] args) {
        NDIFINDERApi apiInstance = new NDIFINDERApi();
        try {
            apiInstance.refreshPost();
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIFINDERApi#refreshPost");
            e.printStackTrace();
        }
    }
}

NDIFINDERApi *apiInstance = [[NDIFINDERApi alloc] init];

// Refresh NDI Source List
[apiInstance refreshPostWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhr = new XMLHttpRequest();
xhr.open("POST", "http://192.168.2.197:8080/refresh", true);
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class refreshPostExample
    {
        public void main()
        {

            var apiInstance = new NDIFINDERApi();

            try
            {
                // Refresh NDI Source List
                apiInstance.refreshPost();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NDIFINDERApi.refreshPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNDIFINDERApi();

try {
    $api_instance->refreshPost();
} catch (Exception $e) {
    echo 'Exception when calling NDIFINDERApi->refreshPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NDIFINDERApi;

my $api_instance = WWW::SwaggerClient::NDIFINDERApi->new();

eval { 
    $api_instance->refreshPost();
};
if ($@) {
    warn "Exception when calling NDIFINDERApi->refreshPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NDIFINDERApi()

try: 
    # Refresh NDI Source List
    api_instance.refresh_post()
except ApiException as e:
    print("Exception when calling NDIFINDERApi->refreshPost: %s\n" % e)

Parameters

Responses

Status: default - Immediately all the sources on the network will be visible

Example data

Content-Type: Example Status response
{}

resetGet

Reset NDI Source List

This command will immediately reset NDI Source List.


/reset

Usage and SDK Samples

curl -X GET\
-H "Accept: text"\
"http://192.168.2.197:8080/reset"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NDIFINDERApi;

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

public class NDIFINDERApiExample {

    public static void main(String[] args) {
        
        NDIFINDERApi apiInstance = new NDIFINDERApi();
        try {
            apiInstance.resetGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIFINDERApi#resetGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NDIFINDERApi;

public class NDIFINDERApiExample {

    public static void main(String[] args) {
        NDIFINDERApi apiInstance = new NDIFINDERApi();
        try {
            apiInstance.resetGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIFINDERApi#resetGet");
            e.printStackTrace();
        }
    }
}

NDIFINDERApi *apiInstance = [[NDIFINDERApi alloc] init];

// Reset NDI Source List
[apiInstance resetGetWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
if (this.readyState == 4 && this.status == 200) {
  console.log(this.responseText);
 }
};
xhttp.open("GET", "http://192.168.2.197:8080/reset", true);
xhttp.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class resetGetExample
    {
        public void main()
        {

            var apiInstance = new NDIFINDERApi();

            try
            {
                // Reset NDI Source List
                apiInstance.resetGet();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NDIFINDERApi.resetGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNDIFINDERApi();

try {
    $api_instance->resetGet();
} catch (Exception $e) {
    echo 'Exception when calling NDIFINDERApi->resetGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NDIFINDERApi;

my $api_instance = WWW::SwaggerClient::NDIFINDERApi->new();

eval { 
    $api_instance->resetGet();
};
if ($@) {
    warn "Exception when calling NDIFINDERApi->resetGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NDIFINDERApi()

try: 
    # Reset NDI Source List
    api_instance.reset_get()
except ApiException as e:
    print("Exception when calling NDIFINDERApi->resetGet: %s\n" % e)

Parameters

Responses

Status: default - Immediately all the sources on the network will be visible

Example data

Content-Type: Example Status response
{}

resetPost

Reset NDI Source List

This command will immediately reset NDI Source List.


/reset

Usage and SDK Samples

curl -X POST\
-H "Accept: text"\
"http://192.168.2.197:8080/reset"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NDIFINDERApi;

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

public class NDIFINDERApiExample {

    public static void main(String[] args) {
        
        NDIFINDERApi apiInstance = new NDIFINDERApi();
        try {
            apiInstance.resetPost();
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIFINDERApi#resetPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NDIFINDERApi;

public class NDIFINDERApiExample {

    public static void main(String[] args) {
        NDIFINDERApi apiInstance = new NDIFINDERApi();
        try {
            apiInstance.resetPost();
        } catch (ApiException e) {
            System.err.println("Exception when calling NDIFINDERApi#resetPost");
            e.printStackTrace();
        }
    }
}

NDIFINDERApi *apiInstance = [[NDIFINDERApi alloc] init];

// Reset NDI Source List
[apiInstance resetPostWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhr = new XMLHttpRequest();
xhr.open("POST", "http://192.168.2.197:8080/reset", true);
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class resetPostExample
    {
        public void main()
        {

            var apiInstance = new NDIFINDERApi();

            try
            {
                // Reset NDI Source List
                apiInstance.resetPost();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NDIFINDERApi.resetPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNDIFINDERApi();

try {
    $api_instance->resetPost();
} catch (Exception $e) {
    echo 'Exception when calling NDIFINDERApi->resetPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NDIFINDERApi;

my $api_instance = WWW::SwaggerClient::NDIFINDERApi->new();

eval { 
    $api_instance->resetPost();
};
if ($@) {
    warn "Exception when calling NDIFINDERApi->resetPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NDIFINDERApi()

try: 
    # Reset NDI Source List
    api_instance.reset_post()
except ApiException as e:
    print("Exception when calling NDIFINDERApi->resetPost: %s\n" % e)

Parameters

Responses

Status: default - Immediately all the sources on the network will be visible

Example data

Content-Type: Example Status response
{}

PTZ

birddogptzsetupGet

Retrieve PTZ Settings

This command will get ptz settings


/birddogptzsetup

Usage and SDK Samples

curl -X GET\
-H "Accept: text"\
"http://192.168.2.197:8080/birddogptzsetup?PanSpeed=&TiltSpeed=&ZoomSpeed="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PTZApi;

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

public class PTZApiExample {

    public static void main(String[] args) {
        
        PTZApi apiInstance = new PTZApi();
        Object panSpeed = ; // Object | Range from 0 to 21
        Object tiltSpeed = ; // Object | Range from 0 to 18
        Object zoomSpeed = ; // Object | Range from 0 to 7
        try {
            apiInstance.birddogptzsetupGet(panSpeed, tiltSpeed, zoomSpeed);
        } catch (ApiException e) {
            System.err.println("Exception when calling PTZApi#birddogptzsetupGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PTZApi;

public class PTZApiExample {

    public static void main(String[] args) {
        PTZApi apiInstance = new PTZApi();
        Object panSpeed = ; // Object | Range from 0 to 21
        Object tiltSpeed = ; // Object | Range from 0 to 18
        Object zoomSpeed = ; // Object | Range from 0 to 7
        try {
            apiInstance.birddogptzsetupGet(panSpeed, tiltSpeed, zoomSpeed);
        } catch (ApiException e) {
            System.err.println("Exception when calling PTZApi#birddogptzsetupGet");
            e.printStackTrace();
        }
    }
}
Object *panSpeed = ; // Range from 0 to 21 (optional)
Object *tiltSpeed = ; // Range from 0 to 18 (optional)
Object *zoomSpeed = ; // Range from 0 to 7 (optional)

PTZApi *apiInstance = [[PTZApi alloc] init];

// Retrieve PTZ Settings
[apiInstance birddogptzsetupGetWith:panSpeed
    tiltSpeed:tiltSpeed
    zoomSpeed:zoomSpeed
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
if (this.readyState == 4 && this.status == 200) {
  console.log(this.responseText);
 }
};
xhttp.open("GET", "http://192.168.2.197:8080/birddogptzsetup", true);
xhttp.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class birddogptzsetupGetExample
    {
        public void main()
        {

            var apiInstance = new PTZApi();
            var panSpeed = new Object(); // Object | Range from 0 to 21 (optional) 
            var tiltSpeed = new Object(); // Object | Range from 0 to 18 (optional) 
            var zoomSpeed = new Object(); // Object | Range from 0 to 7 (optional) 

            try
            {
                // Retrieve PTZ Settings
                apiInstance.birddogptzsetupGet(panSpeed, tiltSpeed, zoomSpeed);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PTZApi.birddogptzsetupGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPTZApi();
$panSpeed = ; // Object | Range from 0 to 21
$tiltSpeed = ; // Object | Range from 0 to 18
$zoomSpeed = ; // Object | Range from 0 to 7

try {
    $api_instance->birddogptzsetupGet($panSpeed, $tiltSpeed, $zoomSpeed);
} catch (Exception $e) {
    echo 'Exception when calling PTZApi->birddogptzsetupGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PTZApi;

my $api_instance = WWW::SwaggerClient::PTZApi->new();
my $panSpeed = ; # Object | Range from 0 to 21
my $tiltSpeed = ; # Object | Range from 0 to 18
my $zoomSpeed = ; # Object | Range from 0 to 7

eval { 
    $api_instance->birddogptzsetupGet(panSpeed => $panSpeed, tiltSpeed => $tiltSpeed, zoomSpeed => $zoomSpeed);
};
if ($@) {
    warn "Exception when calling PTZApi->birddogptzsetupGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PTZApi()
panSpeed =  # Object | Range from 0 to 21 (optional)
tiltSpeed =  # Object | Range from 0 to 18 (optional)
zoomSpeed =  # Object | Range from 0 to 7 (optional)

try: 
    # Retrieve PTZ Settings
    api_instance.birddogptzsetup_get(panSpeed=panSpeed, tiltSpeed=tiltSpeed, zoomSpeed=zoomSpeed)
except ApiException as e:
    print("Exception when calling PTZApi->birddogptzsetupGet: %s\n" % e)

Parameters

Query parameters
Name Description
PanSpeed
Object (string)
Range from 0 to 21
TiltSpeed
Object (string)
Range from 0 to 18
ZoomSpeed
Object (string)
Range from 0 to 7

Responses

Status: default - Get PTZ Settings

Example data

Content-Type: Example Status response
{"PanSpeed":"8","TiltSpeed":"8","ZoomSpeed":"4"}

birddogptzsetupPost

Set PTZ Settings

This command will set ptz settings


/birddogptzsetup

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json"\
-d {\"PanSpeed\":\"8\",\"TiltSpeed\":\"8\",\"ZoomSpeed\":\"4\"} http://192.168.2.197:8080/birddogptzsetup
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PTZApi;

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

public class PTZApiExample {

    public static void main(String[] args) {
        
        PTZApi apiInstance = new PTZApi();
        Object panSpeed = ; // Object | Range from 0 to 21
        Object tiltSpeed = ; // Object | Range from 0 to 18
        Object zoomSpeed = ; // Object | Range from 0 to 7
        try {
            apiInstance.birddogptzsetupPost(panSpeed, tiltSpeed, zoomSpeed);
        } catch (ApiException e) {
            System.err.println("Exception when calling PTZApi#birddogptzsetupPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PTZApi;

public class PTZApiExample {

    public static void main(String[] args) {
        PTZApi apiInstance = new PTZApi();
        Object panSpeed = ; // Object | Range from 0 to 21
        Object tiltSpeed = ; // Object | Range from 0 to 18
        Object zoomSpeed = ; // Object | Range from 0 to 7
        try {
            apiInstance.birddogptzsetupPost(panSpeed, tiltSpeed, zoomSpeed);
        } catch (ApiException e) {
            System.err.println("Exception when calling PTZApi#birddogptzsetupPost");
            e.printStackTrace();
        }
    }
}
Object *panSpeed = ; // Range from 0 to 21 (optional)
Object *tiltSpeed = ; // Range from 0 to 18 (optional)
Object *zoomSpeed = ; // Range from 0 to 7 (optional)

PTZApi *apiInstance = [[PTZApi alloc] init];

// Set PTZ Settings
[apiInstance birddogptzsetupPostWith:panSpeed
    tiltSpeed:tiltSpeed
    zoomSpeed:zoomSpeed
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhr = new XMLHttpRequest();
var url = "http://192.168.2.197:8080/birddogptzsetup";
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/json");
xhr.onreadystatechange = function () {
    if (xhr.readyState === 4 && xhr.status === 200) {
	  console.log(xhr.responseText);
    }
};
var data = JSON.stringify({"PanSpeed":"8","TiltSpeed":"8","ZoomSpeed":"4"});
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class birddogptzsetupPostExample
    {
        public void main()
        {

            var apiInstance = new PTZApi();
            var panSpeed = new Object(); // Object | Range from 0 to 21 (optional) 
            var tiltSpeed = new Object(); // Object | Range from 0 to 18 (optional) 
            var zoomSpeed = new Object(); // Object | Range from 0 to 7 (optional) 

            try
            {
                // Set PTZ Settings
                apiInstance.birddogptzsetupPost(panSpeed, tiltSpeed, zoomSpeed);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PTZApi.birddogptzsetupPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPTZApi();
$panSpeed = ; // Object | Range from 0 to 21
$tiltSpeed = ; // Object | Range from 0 to 18
$zoomSpeed = ; // Object | Range from 0 to 7

try {
    $api_instance->birddogptzsetupPost($panSpeed, $tiltSpeed, $zoomSpeed);
} catch (Exception $e) {
    echo 'Exception when calling PTZApi->birddogptzsetupPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PTZApi;

my $api_instance = WWW::SwaggerClient::PTZApi->new();
my $panSpeed = ; # Object | Range from 0 to 21
my $tiltSpeed = ; # Object | Range from 0 to 18
my $zoomSpeed = ; # Object | Range from 0 to 7

eval { 
    $api_instance->birddogptzsetupPost(panSpeed => $panSpeed, tiltSpeed => $tiltSpeed, zoomSpeed => $zoomSpeed);
};
if ($@) {
    warn "Exception when calling PTZApi->birddogptzsetupPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PTZApi()
panSpeed =  # Object | Range from 0 to 21 (optional)
tiltSpeed =  # Object | Range from 0 to 18 (optional)
zoomSpeed =  # Object | Range from 0 to 7 (optional)

try: 
    # Set PTZ Settings
    api_instance.birddogptzsetup_post(panSpeed=panSpeed, tiltSpeed=tiltSpeed, zoomSpeed=zoomSpeed)
except ApiException as e:
    print("Exception when calling PTZApi->birddogptzsetupPost: %s\n" % e)

Parameters

Query parameters
Name Description
PanSpeed
Object (string)
Range from 0 to 21
TiltSpeed
Object (string)
Range from 0 to 18
ZoomSpeed
Object (string)
Range from 0 to 7

Responses

Status: default - Set PTZ Settings

Example data

Content-Type: Example Status response
{"PanSpeed":"8","TiltSpeed":"8","ZoomSpeed":"4"}

recallPost

Recall Preset

This command will recall preset


/recall

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json"\
-d {\"Preset\":\"Preset-1\"} http://192.168.2.197:8080/recall
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PTZApi;

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

public class PTZApiExample {

    public static void main(String[] args) {
        
        PTZApi apiInstance = new PTZApi();
        Object preset = ; // Object | Preset-1 (Range from 1 to 9)
        try {
            apiInstance.recallPost(preset);
        } catch (ApiException e) {
            System.err.println("Exception when calling PTZApi#recallPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PTZApi;

public class PTZApiExample {

    public static void main(String[] args) {
        PTZApi apiInstance = new PTZApi();
        Object preset = ; // Object | Preset-1 (Range from 1 to 9)
        try {
            apiInstance.recallPost(preset);
        } catch (ApiException e) {
            System.err.println("Exception when calling PTZApi#recallPost");
            e.printStackTrace();
        }
    }
}
Object *preset = ; // Preset-1 (Range from 1 to 9) (optional)

PTZApi *apiInstance = [[PTZApi alloc] init];

// Recall Preset
[apiInstance recallPostWith:preset
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhr = new XMLHttpRequest();
var url = "http://192.168.2.197:8080/recall";
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/json");
xhr.onreadystatechange = function () {
    if (xhr.readyState === 4 && xhr.status === 200) {
	  console.log(xhr.responseText);
    }
};
var data = JSON.stringify({"Preset":"Preset-1"});
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class recallPostExample
    {
        public void main()
        {

            var apiInstance = new PTZApi();
            var preset = new Object(); // Object | Preset-1 (Range from 1 to 9) (optional) 

            try
            {
                // Recall Preset
                apiInstance.recallPost(preset);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PTZApi.recallPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPTZApi();
$preset = ; // Object | Preset-1 (Range from 1 to 9)

try {
    $api_instance->recallPost($preset);
} catch (Exception $e) {
    echo 'Exception when calling PTZApi->recallPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PTZApi;

my $api_instance = WWW::SwaggerClient::PTZApi->new();
my $preset = ; # Object | Preset-1 (Range from 1 to 9)

eval { 
    $api_instance->recallPost(preset => $preset);
};
if ($@) {
    warn "Exception when calling PTZApi->recallPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PTZApi()
preset =  # Object | Preset-1 (Range from 1 to 9) (optional)

try: 
    # Recall Preset
    api_instance.recall_post(preset=preset)
except ApiException as e:
    print("Exception when calling PTZApi->recallPost: %s\n" % e)

Parameters

Query parameters
Name Description
Preset
Object (string)
Preset-1 (Range from 1 to 9)

Responses

Status: default - Recall Preset

Example data

Content-Type: Example Status response
{"Preset":"Preset-1"}

savePost

Save Preset

This command will save preset


/save

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json"\
-d {\"Preset\":\"Preset-1\"} http://192.168.2.197:8080/save
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PTZApi;

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

public class PTZApiExample {

    public static void main(String[] args) {
        
        PTZApi apiInstance = new PTZApi();
        Object preset = ; // Object | Preset-1 (Range from 1 to 9)
        try {
            apiInstance.savePost(preset);
        } catch (ApiException e) {
            System.err.println("Exception when calling PTZApi#savePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PTZApi;

public class PTZApiExample {

    public static void main(String[] args) {
        PTZApi apiInstance = new PTZApi();
        Object preset = ; // Object | Preset-1 (Range from 1 to 9)
        try {
            apiInstance.savePost(preset);
        } catch (ApiException e) {
            System.err.println("Exception when calling PTZApi#savePost");
            e.printStackTrace();
        }
    }
}
Object *preset = ; // Preset-1 (Range from 1 to 9) (optional)

PTZApi *apiInstance = [[PTZApi alloc] init];

// Save Preset
[apiInstance savePostWith:preset
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhr = new XMLHttpRequest();
var url = "http://192.168.2.197:8080/save";
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/json");
xhr.onreadystatechange = function () {
    if (xhr.readyState === 4 && xhr.status === 200) {
	  console.log(xhr.responseText);
    }
};
var data = JSON.stringify({"Preset":"Preset-1"});
xhr.send(data);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class savePostExample
    {
        public void main()
        {

            var apiInstance = new PTZApi();
            var preset = new Object(); // Object | Preset-1 (Range from 1 to 9) (optional) 

            try
            {
                // Save Preset
                apiInstance.savePost(preset);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PTZApi.savePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPTZApi();
$preset = ; // Object | Preset-1 (Range from 1 to 9)

try {
    $api_instance->savePost($preset);
} catch (Exception $e) {
    echo 'Exception when calling PTZApi->savePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PTZApi;

my $api_instance = WWW::SwaggerClient::PTZApi->new();
my $preset = ; # Object | Preset-1 (Range from 1 to 9)

eval { 
    $api_instance->savePost(preset => $preset);
};
if ($@) {
    warn "Exception when calling PTZApi->savePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PTZApi()
preset =  # Object | Preset-1 (Range from 1 to 9) (optional)

try: 
    # Save Preset
    api_instance.save_post(preset=preset)
except ApiException as e:
    print("Exception when calling PTZApi->savePost: %s\n" % e)

Parameters

Query parameters
Name Description
Preset
Object (string)
Preset-1 (Range from 1 to 9)

Responses

Status: default - Save Preset

Example data

Content-Type: Example Status response
{"Preset":"Preset-1"}

EXPOSURE

birddogexpsetupGet

Retrieve Exposure Settings

This command will get exposure settings


/birddogexpsetup

Usage and SDK Samples

curl -X GET\
-H "Accept: text"\
"http://192.168.2.197:8080/birddogexpsetup?AeResponse=&BackLight=&BrightLevel=&ExpCompEn=&ExpCompLvl=&ExpMode=&GainLevel=&GainLimit=&GainPoint=&GainPointPosition=&HighSensitivity=&IrisLevel=&ShutterControlOverwrite=&ShutterMaxSpeed=&ShutterMinSpeed=&ShutterSpeed=&ShutterSpeedOverwrite=&SlowShutterEn=&SlowShutterLimit=&Spotlight="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EXPOSUREApi;

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

public class EXPOSUREApiExample {

    public static void main(String[] args) {
        
        EXPOSUREApi apiInstance = new EXPOSUREApi();
        Object aeResponse = ; // Object | Range (1 to 48)
        Object backLight = ; // Object | On, Off
        Object brightLevel = ; // Object | Range (0, 5 to 31)
        Object expCompEn = ; // Object | On, Off
        Object expCompLvl = ; // Object | Range (0 to 14, -128 to 127)
        Object expMode = ; // Object | FULL-AUTO, MANUAL, SHUTTER-PRI, IRIS-PRI, BRIGHT
        Object gainLevel = ; // Object | Range (1 to GainLimit)
        Object gainLimit = ; // Object | Range (4 to 15)
        Object gainPoint = ; // Object | On, Off
        Object gainPointPosition = ; // Object | Range (1 to 13)
        Object highSensitivity = ; // Object | On, Off
        Object irisLevel = ; // Object | Range (0, 5 to 17)
        Object shutterControlOverwrite = ; // Object | On, Off
        Object shutterMaxSpeed = ; // Object | Range (20 to 33)
        Object shutterMinSpeed = ; // Object | Range (16 to ShutterMaxSpeed)
        Object shutterSpeed = ; // Object | Range (0 to 21)
        Object shutterSpeedOverwrite = ; // Object | Range(30 - 110)
        Object slowShutterEn = ; // Object | On, Off
        Object slowShutterLimit = ; // Object | Range (1 to 6)
        Object spotlight = ; // Object | On, Off
        try {
            apiInstance.birddogexpsetupGet(aeResponse, backLight, brightLevel, expCompEn, expCompLvl, expMode, gainLevel, gainLimit, gainPoint, gainPointPosition, highSensitivity, irisLevel, shutterControlOverwrite, shutterMaxSpeed, shutterMinSpeed, shutterSpeed, shutterSpeedOverwrite, slowShutterEn, slowShutterLimit, spotlight);
        } catch (ApiException e) {
            System.err.println("Exception when calling EXPOSUREApi#birddogexpsetupGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EXPOSUREApi;

public class EXPOSUREApiExample {

    public static void main(String[] args) {
        EXPOSUREApi apiInstance = new EXPOSUREApi();
        Object aeResponse = ; // Object | Range (1 to 48)
        Object backLight = ; // Object | On, Off
        Object brightLevel = ; // Object | Range (0, 5 to 31)
        Object expCompEn = ; // Object | On, Off
        Object expCompLvl = ; // Object | Range (0 to 14, -128 to 127)
        Object expMode = ; // Object | FULL-AUTO, MANUAL, SHUTTER-PRI, IRIS-PRI, BRIGHT
        Object gainLevel = ; // Object | Range (1 to GainLimit)
        Object gainLimit = ; // Object | Range (4 to 15)
        Object gainPoint = ; // Object | On, Off
        Object gainPointPosition = ; // Object | Range (1 to 13)
        Object highSensitivity = ; // Object | On, Off
        Object irisLevel = ; // Object | Range (0, 5 to 17)
        Object shutterControlOverwrite = ; // Object | On, Off
        Object shutterMaxSpeed = ; // Object | Range (20 to 33)
        Object shutterMinSpeed = ; // Object | Range (16 to ShutterMaxSpeed)
        Object shutterSpeed = ; // Object | Range (0 to 21)
        Object shutterSpeedOverwrite = ; // Object | Range(30 - 110)
        Object slowShutterEn = ; // Object | On, Off
        Object slowShutterLimit = ; // Object | Range (1 to 6)
        Object spotlight = ; // Object | On, Off
        try {
            apiInstance.birddogexpsetupGet(aeResponse, backLight, brightLevel, expCompEn, expCompLvl, expMode, gainLevel, gainLimit, gainPoint, gainPointPosition, highSensitivity, irisLevel, shutterControlOverwrite, shutterMaxSpeed, shutterMinSpeed, shutterSpeed, shutterSpeedOverwrite, slowShutterEn, slowShutterLimit, spotlight);
        } catch (ApiException e) {
            System.err.println("Exception when calling EXPOSUREApi#birddogexpsetupGet");
            e.printStackTrace();
        }
    }
}
Object *aeResponse = ; // Range (1 to 48) (optional)
Object *backLight = ; // On, Off (optional)
Object *brightLevel = ; // Range (0, 5 to 31) (optional)
Object *expCompEn = ; // On, Off (optional)
Object *expCompLvl = ; // Range (0 to 14, -128 to 127) (optional)
Object *expMode = ; // FULL-AUTO, MANUAL, SHUTTER-PRI, IRIS-PRI, BRIGHT (optional)
Object *gainLevel = ; // Range (1 to GainLimit) (optional)
Object *gainLimit = ; // Range (4 to 15) (optional)
Object *gainPoint = ; // On, Off (optional)
Object *gainPointPosition = ; // Range (1 to 13) (optional)
Object *highSensitivity = ; // On, Off (optional)
Object *irisLevel = ; // Range (0, 5 to 17) (optional)
Object *shutterControlOverwrite = ; // On, Off (optional)
Object *shutterMaxSpeed = ; // Range (20 to 33) (optional)
Object *shutterMinSpeed = ; // Range (16 to ShutterMaxSpeed) (optional)
Object *shutterSpeed = ; // Range (0 to 21) (optional)
Object *shutterSpeedOverwrite = ; // Range(30 - 110) (optional)
Object *slowShutterEn = ; // On, Off (optional)
Object *slowShutterLimit = ; // Range (1 to 6) (optional)
Object *spotlight = ; // On, Off (optional)

EXPOSUREApi *apiInstance = [[EXPOSUREApi alloc] init];

// Retrieve Exposure Settings
[apiInstance birddogexpsetupGetWith:aeResponse
    backLight:backLight
    brightLevel:brightLevel
    expCompEn:expCompEn
    expCompLvl:expCompLvl
    expMode:expMode
    gainLevel:gainLevel
    gainLimit:gainLimit
    gainPoint:gainPoint
    gainPointPosition:gainPointPosition
    highSensitivity:highSensitivity
    irisLevel:irisLevel
    shutterControlOverwrite:shutterControlOverwrite
    shutterMaxSpeed:shutterMaxSpeed
    shutterMinSpeed:shutterMinSpeed
    shutterSpeed:shutterSpeed
    shutterSpeedOverwrite:shutterSpeedOverwrite
    slowShutterEn:slowShutterEn
    slowShutterLimit:slowShutterLimit
    spotlight:spotlight
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
if (this.readyState == 4 && this.status == 200) {
  console.log(this.responseText);
 }
};
xhttp.open("GET", "http://192.168.2.197:8080/birddogexpsetup", true);
xhttp.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class birddogexpsetupGetExample
    {
        public void main()
        {

            var apiInstance = new EXPOSUREApi();
            var aeResponse = new Object(); // Object | Range (1 to 48) (optional) 
            var backLight = new Object(); // Object | On, Off (optional) 
            var brightLevel = new Object(); // Object | Range (0, 5 to 31) (optional) 
            var expCompEn = new Object(); // Object | On, Off (optional) 
            var expCompLvl = new Object(); // Object | Range (0 to 14, -128 to 127) (optional) 
            var expMode = new Object(); // Object | FULL-AUTO, MANUAL, SHUTTER-PRI, IRIS-PRI, BRIGHT (optional) 
            var gainLevel = new Object(); // Object | Range (1 to GainLimit) (optional) 
            var gainLimit = new Object(); // Object | Range (4 to 15) (optional) 
            var gainPoint = new Object(); // Object | On, Off (optional) 
            var gainPointPosition = new Object(); // Object | Range (1 to 13) (optional) 
            var highSensitivity = new Object(); // Object | On, Off (optional) 
            var irisLevel = new Object(); // Object | Range (0, 5 to 17) (optional) 
            var shutterControlOverwrite = new Object(); // Object | On, Off (optional) 
            var shutterMaxSpeed = new Object(); // Object | Range (20 to 33) (optional) 
            var shutterMinSpeed = new Object(); // Object | Range (16 to ShutterMaxSpeed) (optional) 
            var shutterSpeed = new Object(); // Object | Range (0 to 21) (optional) 
            var shutterSpeedOverwrite = new Object(); // Object | Range(30 - 110) (optional) 
            var slowShutterEn = new Object(); // Object | On, Off (optional) 
            var slowShutterLimit = new Object(); // Object | Range (1 to 6) (optional) 
            var spotlight = new Object(); // Object | On, Off (optional) 

            try
            {
                // Retrieve Exposure Settings
                apiInstance.birddogexpsetupGet(aeResponse, backLight, brightLevel, expCompEn, expCompLvl, expMode, gainLevel, gainLimit, gainPoint, gainPointPosition, highSensitivity, irisLevel, shutterControlOverwrite, shutterMaxSpeed, shutterMinSpeed, shutterSpeed, shutterSpeedOverwrite, slowShutterEn, slowShutterLimit, spotlight);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EXPOSUREApi.birddogexpsetupGet: " + e.Message )