put_pvr_programmed_id
Update properties of a scheduled recording on your Freebox, including start/end times, channel, name, and enable state. Handles errors like conflicts or disk full.
Instructions
Update a Precord properties
Error codes: noent, inval, inval_date_fmt, inval_end_before_start, system_time_incorrect, record_duration_too_long, record_date_in_past, unknown_channel, no_channel_svc, only_auto_disable, cannot_change_en_state, cannot_disable_has_data, internal_error, none, file_access_error, disk_full, private_but_no_private_dir, network_problem, resource_problem, no_stream_available, no_data_received, missed, stopped, unknown_error
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id__path | Yes | (Path parameter) | |
| id | No | precord id | |
| media | No | media name on which the record will be written to. See the Media API for more info. This property and can be empty when the file backing the record is not available, for example when secure is set. | |
| path | No | destination directory on the media storage where the record will be written to | |
| has_record_gen | No | if true, this precord has been generated using a Generator | |
| record_gen_id | No | if has_record_gen, this is the id of the generator | |
| conflict | No | if true this record may conflict with another record | |
| overlap_list | No | in case of conflict, this will contain the list of records id that may conflict with this record | |
| enabled | No | it only applies to generated records. If false the generated precord will be skipped. | |
| altered | No | a precord is altered when some part of the recording may be missing. This can be the case if a conflict occurred during the recording (or connection was down) | |
| state | No | Values: `disabled`: disabled; `start_error`: failed to start; `waiting_start_time`: scheduled; `starting`: starting; `running`: running; `running_error`: running with error; `failed`: failed; `finished`: finished | |
| error | No | ||
| channel_uuid | No | channel uuid | |
| channel_name | No | optional channel name | |
| channel_quality | No | ||
| channel_type | No | Values: `‘’ (empty string)`: auto; `iptv`: use only iptv streams; `dvb`: use only dvb streams | |
| name | No | record name | |
| subname | No | record subname | |
| broadcast_type | No | ||
| start | No | record start timestamp | |
| end | No | record end timestamp | |
| legacy_uri | No | only used for legacy apps. Use channel_uuid instead when available NOTE: only visible when called from player | |
| force_channel_name | No | only used for legacy apps. Use channel_uuid instead when available NOTE: only visible when called from player |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||