Trigger a real-time logging event

import requests
headers = {
    'Authorization': 'Bearer [access_token]',
    'Content-Type': 'application/json',
    'x-client-version': '2.0.0'
}
data = {
    'action_type': 'single_press',
    'offset': 0,
    'start': {
        'smpte_timecode': '01:00:00:00',
        'rate': {
            'playback': [24000, 1001],
            'ntsc': 'non_drop'
        }
    },
    'duration': {
        'smpte_timecode': '00:00:00:01',
        'rate': {
            'playback': [24000, 1001],
            'ntsc': 'non_drop'
        }
    }
}
response = requests.post(
    'https://api.frame.io/v2/devices/channels/{channel_id}/inputs/{input_index}/trigger',
    headers=headers,
    json=data
)
result = response.json()
print(result)

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!

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

channel_idstringRequiredformat: "uuid"

Device channel id

input_indexintegerRequired>=0

An 0-indexed integer that will be used to identify the input

Request

This endpoint expects an object.

action_typeenumOptional

Allowed values:

offsetintegerOptional>=0

startobjectOptional

durationobjectOptional

Response

Errors

401

Unauthorized Error

Trigger a real-time logging event

Authentication

Path parameters

Headers

Request

Response

Errors

Authentication

Path parameters

Headers

Request

Response

Errors

1	import requests
2
3	headers = {
4	'Authorization': 'Bearer [access_token]',
5	'Content-Type': 'application/json',
6	'x-client-version': '2.0.0'
7	}
8
9	data = {
10	'action_type': 'single_press',
11	'offset': 0,
12	'start': {
13	'smpte_timecode': '01:00:00:00',
14	'rate': {
15	'playback': [24000, 1001],
16	'ntsc': 'non_drop'
17	}
18	},
19	'duration': {
20	'smpte_timecode': '00:00:00:01',
21	'rate': {
22	'playback': [24000, 1001],
23	'ntsc': 'non_drop'
24	}
25	}
26	}
27
28	response = requests.post(
29	'https://api.frame.io/v2/devices/channels/{channel_id}/inputs/{input_index}/trigger',
30	headers=headers,
31	json=data
32	)
33
34	result = response.json()
35	print(result)