# VmosoApi.StreamvApi

All URIs are relative to *https://www.vmoso.com/svc*

Method | HTTP request | Description
------------- | ------------- | -------------
[**getStreamCounts**](StreamvApi.md#getStreamCounts) | **GET** /streamv2/counts | 
[**search**](StreamvApi.md#search) | **GET** /streamv2/search | 


<a name="getStreamCounts"></a>
# **getStreamCounts**
> GetStreamCountsResult getStreamCounts(options)



Use this API to get the count of tiles in a stream.

### Example
```javascript
var VmosoApi = require('vmoso-api');
var defaultClient = VmosoApi.ApiClient.default;

// Configure API key authorization: vmoso_auth
var vmoso_auth = defaultClient.authentications['vmoso_auth'];
vmoso_auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//vmoso_auth.apiKeyPrefix['X-CV-Authorization'] = "Token"

var apiInstance = new VmosoApi.StreamvApi()

var options = ["options_example"]; // {[String]} Search criteria.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStreamCounts(options, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **options** | [**[String]**](String.md)| Search criteria. | 

### Return type

[**GetStreamCountsResult**](GetStreamCountsResult.md)

### Authorization

[vmoso_auth](../README.md#vmoso_auth)

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="search"></a>
# **search**
> SearchResult search(options, opts)



Use this API to retrieve tiles from the stream.

### Example
```javascript
var VmosoApi = require('vmoso-api');
var defaultClient = VmosoApi.ApiClient.default;

// Configure API key authorization: vmoso_auth
var vmoso_auth = defaultClient.authentications['vmoso_auth'];
vmoso_auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//vmoso_auth.apiKeyPrefix['X-CV-Authorization'] = "Token"

var apiInstance = new VmosoApi.StreamvApi()

var options = "options_example"; // {String} Search criteria.

var opts = { 
  'pg': "pg_example", // {String} Pagination preferences for search results.
  'format': "format_example" // {String} Sets the return data.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.search(options, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **options** | **String**| Search criteria. | 
 **pg** | **String**| Pagination preferences for search results. | [optional] 
 **format** | **String**| Sets the return data. | [optional] 

### Return type

[**SearchResult**](SearchResult.md)

### Authorization

[vmoso_auth](../README.md#vmoso_auth)

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json