Skip to content

DevicesApi.md

Latest commit

 

History

History
935 lines (701 loc) · 42.3 KB

DevicesApi.md

File metadata and controls

935 lines (701 loc) · 42.3 KB

DevicesApi

All URIs are relative to https://api.frame.io

Method HTTP request Description
authDeviceConfirmDevice GET /v2/auth/token Polling for Device Authorization
authDeviceRefreshToken POST /v2/auth/token Refresh Device Token
authDeviceRevokeToken POST /v2/auth/revoke Revoke Device Authorization
connectDeviceChannel POST /v2/devices/channels Connect a new device channel
deviceAssetCreate POST /v2/devices/assets Create C2C asset
deviceAssetCreateDeprecated POST /v2/assets Create C2C asset
deviceCreateRealtimeUploadParts POST /v2/devices/assets/{asset_id}/realtime_upload/parts Request upload URLs for real-time upload
deviceHeartbeat POST /v2/devices/heartbeat Heartbeat ping
deviceIdentify GET /v2/devices/me Device Information
deviceListAccounts GET /v2/devices/accounts List accounts
deviceListProjects GET /v2/devices/accounts/{account_id}/projects List projects for account
deviceProjectConnect POST /v2/devices/connect Connect device
deviceProjectDisconnect POST /v2/devices/disconnect Disconnect device
deviceRequestCode POST /v2/device/code Request device code
disconnectAllDeviceChannels POST /v2/devices/channels/disconnect Disconnect all device channels
disconnectDeviceChannel POST /v2/devices/channels/{channel_id}/disconnect Disconnect a specific device channel
getMe GET /v2/me Get the current authenticated User
triggerRealtimeLoggingEvent POST /v2/devices/channels/{channel_id}/inputs/{input_index}/trigger Trigger a real-time logging event

authDeviceConfirmDevice

AuthDeviceConfirmDevice200Response authDeviceConfirmDevice(grantType, clientId, deviceCode, xClientVersion)

Polling for Device Authorization

Once we have handed the pairing code to the user, we need to check and see if they've entered it. To do so, we can make the following request.

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = DevicesApi()
val grantType : kotlin.String = grantType_example // kotlin.String | The type of authorization grant our OAuth system is issuing.
val clientId : kotlin.String = clientId_example // kotlin.String | The unique device id, such as the device serial number. Must be the same as the client id used on the initiation request.
val deviceCode : kotlin.String = deviceCode_example // kotlin.String | The unique `device_code` generated by the server for this authorization attempt. Returned from the initiation request.
val xClientVersion : kotlin.String = 2.16.4 // kotlin.String | Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version.    For more on semantic versions, see here: https://semver.org/
try {
    val result : AuthDeviceConfirmDevice200Response = apiInstance.authDeviceConfirmDevice(grantType, clientId, deviceCode, xClientVersion)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DevicesApi#authDeviceConfirmDevice")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DevicesApi#authDeviceConfirmDevice")
    e.printStackTrace()
}

Parameters

| grantType | kotlin.String| The type of authorization grant our OAuth system is issuing. | [enum: urn:ietf:params:oauth:grant-type:device_code] | | clientId | kotlin.String| The unique device id, such as the device serial number. Must be the same as the client id used on the initiation request. | | | deviceCode | kotlin.String| The unique `device_code` generated by the server for this authorization attempt. Returned from the initiation request. | |

Name Type Description Notes
xClientVersion kotlin.String Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/ [optional] [default to "0.0.0"]

Return type

AuthDeviceConfirmDevice200Response

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

authDeviceRefreshToken

authDeviceRefreshToken(clientId, clientSecret, grantType, refreshTokem)

Refresh Device Token

Refresh your devices token

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = DevicesApi()
val clientId : kotlin.String = clientId_example // kotlin.String | Must be a unique identifier per hardware device, such as a unique hardware serial number. Must be the same as the client id used on initial authorization.
val clientSecret : kotlin.String = clientSecret_example // kotlin.String | A static string, provided by Frame.io to be embedded for a device manufacturer/model. Acts as an identifier within Frame.io.
val grantType : kotlin.String = grantType_example // kotlin.String | Grant type
val refreshTokem : kotlin.String = refreshTokem_example // kotlin.String | A valid `refresh_token`, from a previous authorization. Refresh tokens are valid for 14 days from issuance. This is received after the initial authorization and will receive a new `refresh-token` after every refresh.
try {
    apiInstance.authDeviceRefreshToken(clientId, clientSecret, grantType, refreshTokem)
} catch (e: ClientException) {
    println("4xx response calling DevicesApi#authDeviceRefreshToken")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DevicesApi#authDeviceRefreshToken")
    e.printStackTrace()
}

Parameters

| clientId | kotlin.String| Must be a unique identifier per hardware device, such as a unique hardware serial number. Must be the same as the client id used on initial authorization. | | | clientSecret | kotlin.String| A static string, provided by Frame.io to be embedded for a device manufacturer/model. Acts as an identifier within Frame.io. | | | grantType | kotlin.String| Grant type | [enum: refresh_token] |

Name Type Description Notes
refreshTokem kotlin.String A valid `refresh_token`, from a previous authorization. Refresh tokens are valid for 14 days from issuance. This is received after the initial authorization and will receive a new `refresh-token` after every refresh.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: Not defined

authDeviceRevokeToken

kotlin.String authDeviceRevokeToken(xClientVersion, clientId, clientSecret, token)

Revoke Device Authorization

Revoke device authorization

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = DevicesApi()
val xClientVersion : kotlin.String = 2.16.4 // kotlin.String | Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version.    For more on semantic versions, see here: https://semver.org/
val clientId : kotlin.String = clientId_example // kotlin.String | Must be a unique identifier per hardware device, such as a unique hardware serial number. Must be the same `client_id` used on initial authorization.
val clientSecret : kotlin.String = clientSecret_example // kotlin.String | A static string, provided by Frame.io to be embedded for a device manufacturer/model. Acts as an identifier within Frame.io.
val token : kotlin.String = token_example // kotlin.String | 
try {
    val result : kotlin.String = apiInstance.authDeviceRevokeToken(xClientVersion, clientId, clientSecret, token)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DevicesApi#authDeviceRevokeToken")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DevicesApi#authDeviceRevokeToken")
    e.printStackTrace()
}

Parameters

| xClientVersion | kotlin.String| Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/ | [optional] [default to "0.0.0"] | | clientId | kotlin.String| Must be a unique identifier per hardware device, such as a unique hardware serial number. Must be the same `client_id` used on initial authorization. | [optional] | | clientSecret | kotlin.String| A static string, provided by Frame.io to be embedded for a device manufacturer/model. Acts as an identifier within Frame.io. | [optional] |

Name Type Description Notes
token kotlin.String [optional]

Return type

kotlin.String

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

connectDeviceChannel

ProjectDeviceChannel connectDeviceChannel(xClientVersion, connectDeviceChannelRequest)

Connect a new device channel

We can connect a new channel with the following request

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = DevicesApi()
val xClientVersion : kotlin.String = 2.16.4 // kotlin.String | Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version.    For more on semantic versions, see here: https://semver.org/
val connectDeviceChannelRequest : ConnectDeviceChannelRequest =  // ConnectDeviceChannelRequest | Payload
try {
    val result : ProjectDeviceChannel = apiInstance.connectDeviceChannel(xClientVersion, connectDeviceChannelRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DevicesApi#connectDeviceChannel")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DevicesApi#connectDeviceChannel")
    e.printStackTrace()
}

Parameters

| xClientVersion | kotlin.String| Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/ | [optional] [default to "0.0.0"] |

Name Type Description Notes
connectDeviceChannelRequest ConnectDeviceChannelRequest Payload [optional]

Return type

ProjectDeviceChannel

Authorization

Configure C2COAuth2: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deviceAssetCreate

CreateAsset200Response deviceAssetCreate(xClientVersion, deviceAssetCreateDeprecatedRequest)

Create C2C asset

Asset upload initiation specifically for C2C devices and applications. Note: This endpoint used to be `/v2/assets`, and while that endpoint will continue to function as normal, we suggest you use this one instead.

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = DevicesApi()
val xClientVersion : kotlin.String = 2.16.4 // kotlin.String | Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version.    For more on semantic versions, see here: https://semver.org/
val deviceAssetCreateDeprecatedRequest : DeviceAssetCreateDeprecatedRequest = {"name":"my_video.mp4","filetype":"video/mp4","is_realtime_upload":true,"channel":0,"offset":-10} // DeviceAssetCreateDeprecatedRequest | While supported, we encourage you to switch from `application/x-ww-form-urlencoded` to `application/json` in order to support future workflows that will only be supported through JSON.  When `is_realtime_upload` is `true`, call must be made in `application/json`.
try {
    val result : CreateAsset200Response = apiInstance.deviceAssetCreate(xClientVersion, deviceAssetCreateDeprecatedRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DevicesApi#deviceAssetCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DevicesApi#deviceAssetCreate")
    e.printStackTrace()
}

Parameters

| xClientVersion | kotlin.String| Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/ | [optional] [default to "0.0.0"] |

Name Type Description Notes
deviceAssetCreateDeprecatedRequest DeviceAssetCreateDeprecatedRequest While supported, we encourage you to switch from `application/x-ww-form-urlencoded` to `application/json` in order to support future workflows that will only be supported through JSON. When `is_realtime_upload` is `true`, call must be made in `application/json`. [optional]

Return type

CreateAsset200Response

Authorization

Configure C2COAuth2: ApiClient.accessToken = "" Configure C2CDeviceAuth: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json

deviceAssetCreateDeprecated

CreateAsset200Response deviceAssetCreateDeprecated(xClientVersion, deviceAssetCreateDeprecatedRequest)

Create C2C asset

THIS ENDPOINT IS DEPRECATED. Please use `/v2/devices/assets` instead. While this endpoint will continue to function as normal, we ask that integrations begin using the new endpoint instead for consistency with the rest of the C2C API. Asset upload initiation specifically for C2C devices and applications.

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = DevicesApi()
val xClientVersion : kotlin.String = 2.16.4 // kotlin.String | Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version.    For more on semantic versions, see here: https://semver.org/
val deviceAssetCreateDeprecatedRequest : DeviceAssetCreateDeprecatedRequest = {"name":"my_video.mp4","filetype":"video/mp4","is_realtime_upload":true,"channel":0,"offset":-10} // DeviceAssetCreateDeprecatedRequest | While supported, we encourage you to switch from `application/x-ww-form-urlencoded` to `application/json` in order to support future workflows that will only be supported through JSON.  When `is_realtime_upload` is `true`, call must be made in `application/json`.
try {
    val result : CreateAsset200Response = apiInstance.deviceAssetCreateDeprecated(xClientVersion, deviceAssetCreateDeprecatedRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DevicesApi#deviceAssetCreateDeprecated")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DevicesApi#deviceAssetCreateDeprecated")
    e.printStackTrace()
}

Parameters

| xClientVersion | kotlin.String| Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/ | [optional] [default to "0.0.0"] |

Name Type Description Notes
deviceAssetCreateDeprecatedRequest DeviceAssetCreateDeprecatedRequest While supported, we encourage you to switch from `application/x-ww-form-urlencoded` to `application/json` in order to support future workflows that will only be supported through JSON. When `is_realtime_upload` is `true`, call must be made in `application/json`. [optional]

Return type

CreateAsset200Response

Authorization

Configure C2COAuth2: ApiClient.accessToken = "" Configure C2CDeviceAuth: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json

deviceCreateRealtimeUploadParts

CreateRealtimeUploadParts200Response deviceCreateRealtimeUploadParts(assetId, xClientVersion, createRealtimeUploadPartsRequest)

Request upload URLs for real-time upload

Register real-time upload parts and generate presigned AWS S3 upload PUT URLs.

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = DevicesApi()
val assetId : kotlin.String = 87817fee-e5b1-4aad-8165-2ee2bedd99cc // kotlin.String | Asset ID
val xClientVersion : kotlin.String = 2.16.4 // kotlin.String | Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version.    For more on semantic versions, see here: https://semver.org/
val createRealtimeUploadPartsRequest : CreateRealtimeUploadPartsRequest = {"parts":[{"number":1,"size":2000000000,"is_final":false},{"number":2,"size":1500000000,"is_final":false}]} // CreateRealtimeUploadPartsRequest | Enumerates parts that upload URLs should be created for.
try {
    val result : CreateRealtimeUploadParts200Response = apiInstance.deviceCreateRealtimeUploadParts(assetId, xClientVersion, createRealtimeUploadPartsRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DevicesApi#deviceCreateRealtimeUploadParts")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DevicesApi#deviceCreateRealtimeUploadParts")
    e.printStackTrace()
}

Parameters

| assetId | kotlin.String| Asset ID | | | xClientVersion | kotlin.String| Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/ | [optional] [default to "0.0.0"] |

Name Type Description Notes
createRealtimeUploadPartsRequest CreateRealtimeUploadPartsRequest Enumerates parts that upload URLs should be created for. [optional]

Return type

CreateRealtimeUploadParts200Response

Authorization

Configure C2COAuth2: ApiClient.accessToken = "" Configure C2CDeviceAuth: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deviceHeartbeat

deviceHeartbeat(xClientVersion)

Heartbeat ping

Ommit heartbeat event to Frame.io. This powers the device "online" status in the C2C Connections tab on iOS and Web. This should be called no more then once a minute, and no less than once every 5 minutes.

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = DevicesApi()
val xClientVersion : kotlin.String = 2.16.4 // kotlin.String | Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version.    For more on semantic versions, see here: https://semver.org/
try {
    apiInstance.deviceHeartbeat(xClientVersion)
} catch (e: ClientException) {
    println("4xx response calling DevicesApi#deviceHeartbeat")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DevicesApi#deviceHeartbeat")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
xClientVersion kotlin.String Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/ [optional] [default to "0.0.0"]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

deviceIdentify

ProjectDeviceAuthorization deviceIdentify(xClientVersion)

Device Information

Fetches information about the current device connection. Can be used to verify authorization token and returns information useful to present useful information in your user interface.

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = DevicesApi()
val xClientVersion : kotlin.String = 2.16.4 // kotlin.String | Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version.    For more on semantic versions, see here: https://semver.org/
try {
    val result : ProjectDeviceAuthorization = apiInstance.deviceIdentify(xClientVersion)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DevicesApi#deviceIdentify")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DevicesApi#deviceIdentify")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
xClientVersion kotlin.String Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/ [optional] [default to "0.0.0"]

Return type

ProjectDeviceAuthorization

Authorization

Configure C2CDeviceAuth: ApiClient.accessToken = "" Configure OAuth2: ApiClient.accessToken = "" Configure OAuth2: ApiClient.accessToken = ""

HTTP request headers

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

deviceListAccounts

kotlin.collections.Set<DeviceListAccounts200ResponseInner> deviceListAccounts(xClientVersion)

List accounts

List available accounts to pair your C2C device with.

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = DevicesApi()
val xClientVersion : kotlin.String = 2.16.4 // kotlin.String | Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version.    For more on semantic versions, see here: https://semver.org/
try {
    val result : kotlin.collections.Set<DeviceListAccounts200ResponseInner> = apiInstance.deviceListAccounts(xClientVersion)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DevicesApi#deviceListAccounts")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DevicesApi#deviceListAccounts")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
xClientVersion kotlin.String Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/ [optional] [default to "0.0.0"]

Return type

kotlin.collections.Set<DeviceListAccounts200ResponseInner>

Authorization

Configure C2COAuth2: ApiClient.accessToken = ""

HTTP request headers

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

deviceListProjects

kotlin.collections.Set<DeviceListProjects200ResponseInner> deviceListProjects(accountId, xClientVersion)

List projects for account

List available Projects to pair your C2C device with.

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = DevicesApi()
val accountId : kotlin.String = eefb57e0-79f2-4bc7-9b70-99fbc175175c // kotlin.String | Account ID
val xClientVersion : kotlin.String = 2.16.4 // kotlin.String | Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version.    For more on semantic versions, see here: https://semver.org/
try {
    val result : kotlin.collections.Set<DeviceListProjects200ResponseInner> = apiInstance.deviceListProjects(accountId, xClientVersion)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DevicesApi#deviceListProjects")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DevicesApi#deviceListProjects")
    e.printStackTrace()
}

Parameters

| accountId | kotlin.String| Account ID | |

Name Type Description Notes
xClientVersion kotlin.String Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/ [optional] [default to "0.0.0"]

Return type

kotlin.collections.Set<DeviceListProjects200ResponseInner>

Authorization

Configure C2COAuth2: ApiClient.accessToken = ""

HTTP request headers

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

deviceProjectConnect

ProjectDevice deviceProjectConnect(projectId, xClientVersion)

Connect device

Connect to the provided C2C Project.

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = DevicesApi()
val projectId : kotlin.String = projectId_example // kotlin.String | The `project_id` you intend to connect to
val xClientVersion : kotlin.String = 2.16.4 // kotlin.String | Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version.    For more on semantic versions, see here: https://semver.org/
try {
    val result : ProjectDevice = apiInstance.deviceProjectConnect(projectId, xClientVersion)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DevicesApi#deviceProjectConnect")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DevicesApi#deviceProjectConnect")
    e.printStackTrace()
}

Parameters

| projectId | kotlin.String| The `project_id` you intend to connect to | [optional] |

Name Type Description Notes
xClientVersion kotlin.String Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/ [optional] [default to "0.0.0"]

Return type

ProjectDevice

Authorization

Configure C2COAuth2: ApiClient.accessToken = ""

HTTP request headers

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

deviceProjectDisconnect

deviceProjectDisconnect(xClientVersion)

Disconnect device

Disconnect the device from the project it's currently connected to.

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = DevicesApi()
val xClientVersion : kotlin.String = 2.16.4 // kotlin.String | Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version.    For more on semantic versions, see here: https://semver.org/
try {
    apiInstance.deviceProjectDisconnect(xClientVersion)
} catch (e: ClientException) {
    println("4xx response calling DevicesApi#deviceProjectDisconnect")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DevicesApi#deviceProjectDisconnect")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
xClientVersion kotlin.String Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/ [optional] [default to "0.0.0"]

Return type

null (empty response body)

Authorization

Configure C2COAuth2: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

deviceRequestCode

DeviceRequestCode200Response deviceRequestCode(clientId, clientSecret, scope, xClientVersion)

Request device code

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = DevicesApi()
val clientId : kotlin.String = clientId_example // kotlin.String | A unique identifier for the physical hardware device. This value needs to be guaranteed to be unique for the device. This could be a serial number or a randomly generated UUID.
val clientSecret : kotlin.String = clientSecret_example // kotlin.String | This will be issued to you by Frame.io support and identifies the your device model. This value should be kept secret from the user, and should be encrypted at rest
val scope : kotlin.String = scope_example // kotlin.String | The permissions we are requesting, with spaces used as delimiters. Hardware devices can only request the following two scopes
val xClientVersion : kotlin.String = 2.16.4 // kotlin.String | Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version.    For more on semantic versions, see here: https://semver.org/
try {
    val result : DeviceRequestCode200Response = apiInstance.deviceRequestCode(clientId, clientSecret, scope, xClientVersion)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DevicesApi#deviceRequestCode")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DevicesApi#deviceRequestCode")
    e.printStackTrace()
}

Parameters

| clientId | kotlin.String| A unique identifier for the physical hardware device. This value needs to be guaranteed to be unique for the device. This could be a serial number or a randomly generated UUID. | | | clientSecret | kotlin.String| This will be issued to you by Frame.io support and identifies the your device model. This value should be kept secret from the user, and should be encrypted at rest | | | scope | kotlin.String| The permissions we are requesting, with spaces used as delimiters. Hardware devices can only request the following two scopes | [enum: asset_create, offline] |

Name Type Description Notes
xClientVersion kotlin.String Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/ [optional] [default to "0.0.0"]

Return type

DeviceRequestCode200Response

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

disconnectAllDeviceChannels

disconnectAllDeviceChannels(xClientVersion)

Disconnect all device channels

Disconnects all connected device channels

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = DevicesApi()
val xClientVersion : kotlin.String = 2.16.4 // kotlin.String | Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version.    For more on semantic versions, see here: https://semver.org/
try {
    apiInstance.disconnectAllDeviceChannels(xClientVersion)
} catch (e: ClientException) {
    println("4xx response calling DevicesApi#disconnectAllDeviceChannels")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DevicesApi#disconnectAllDeviceChannels")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
xClientVersion kotlin.String Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/ [optional] [default to "0.0.0"]

Return type

null (empty response body)

Authorization

Configure C2COAuth2: ApiClient.accessToken = ""

HTTP request headers

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

disconnectDeviceChannel

disconnectDeviceChannel(channelId, xClientVersion)

Disconnect a specific device channel

Disconnect a device channel with the following request

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = DevicesApi()
val channelId : kotlin.String = channelId_example // kotlin.String | Device channel id
val xClientVersion : kotlin.String = 2.16.4 // kotlin.String | Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version.    For more on semantic versions, see here: https://semver.org/
try {
    apiInstance.disconnectDeviceChannel(channelId, xClientVersion)
} catch (e: ClientException) {
    println("4xx response calling DevicesApi#disconnectDeviceChannel")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DevicesApi#disconnectDeviceChannel")
    e.printStackTrace()
}

Parameters

| channelId | kotlin.String| Device channel id | |

Name Type Description Notes
xClientVersion kotlin.String Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/ [optional] [default to "0.0.0"]

Return type

null (empty response body)

Authorization

Configure C2COAuth2: ApiClient.accessToken = ""

HTTP request headers

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

getMe

User getMe()

Get the current authenticated User

Get information about the currently authenticated user

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = DevicesApi()
try {
    val result : User = apiInstance.getMe()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DevicesApi#getMe")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DevicesApi#getMe")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

User

Authorization

Configure C2COAuth2: ApiClient.accessToken = "" Configure OAuth2: ApiClient.accessToken = "" Configure OAuth2: ApiClient.accessToken = "" Configure JWT: ApiClient.accessToken = "" Configure DeveloperToken: ApiClient.accessToken = ""

HTTP request headers

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

triggerRealtimeLoggingEvent

triggerRealtimeLoggingEvent(channelId, inputIndex, xClientVersion, triggerRealtimeLoggingEventRequest)

Trigger a real-time logging event

Triggers an event on the device channel. Can be used for logging a quick comment, or for other things that haven't been dreamed up yet!

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = DevicesApi()
val channelId : kotlin.String = 38400000-8cf0-11bd-b23e-10b96e4ef00d // kotlin.String | Device channel id
val inputIndex : kotlin.Int = 56 // kotlin.Int | An 0-indexed integer that will be used to identify the input
val xClientVersion : kotlin.String = 2.16.4 // kotlin.String | Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version.    For more on semantic versions, see here: https://semver.org/
val triggerRealtimeLoggingEventRequest : TriggerRealtimeLoggingEventRequest =  // TriggerRealtimeLoggingEventRequest | 
try {
    apiInstance.triggerRealtimeLoggingEvent(channelId, inputIndex, xClientVersion, triggerRealtimeLoggingEventRequest)
} catch (e: ClientException) {
    println("4xx response calling DevicesApi#triggerRealtimeLoggingEvent")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DevicesApi#triggerRealtimeLoggingEvent")
    e.printStackTrace()
}

Parameters

| channelId | kotlin.String| Device channel id | | | inputIndex | kotlin.Int| An 0-indexed integer that will be used to identify the input | | | xClientVersion | kotlin.String| Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/ | [optional] [default to "0.0.0"] |

Name Type Description Notes
triggerRealtimeLoggingEventRequest TriggerRealtimeLoggingEventRequest [optional]

Return type

null (empty response body)

Authorization

Configure C2COAuth2: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json