Difference between revisions of "Truxton media set status"
Jump to navigation
Jump to search
(Created page with "This sets the status of the media. It corresponds to the <code>MediaStatusID</code> column of the <code>Media</code> table. It can be one of the Media Statu...") |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
This sets the [[Media Status|status]] of the media. | This sets the [[Media Status|status]] of the media. | ||
| − | It corresponds to the <code>MediaStatusID</code> column of the <code>Media</code> table. | + | It corresponds to the <code>[MediaStatusID]</code> column of the <code><nowiki>[</nowiki>[[Media Table|Media]]<nowiki>]</nowiki></code> table. |
| − | It can be one of the [[Media Status|defined constants]] but it must be one of the values in the <code>ID</code> column of the <code>MediaStatus</code> table. | + | It can be one of the [[Media Status|defined constants]] but it must be one of the values in the <code>[ID]</code> column of the <code>[MediaStatus]</code> table. |
=Syntax= | =Syntax= | ||
| − | < | + | <source lang="C"> |
void truxton_media_set_status( uint64_t media_handle, uint64_t status ); | void truxton_media_set_status( uint64_t media_handle, uint64_t status ); | ||
| − | </ | + | </source> |
=Parameters= | =Parameters= | ||
| Line 16: | Line 16: | ||
=Sample= | =Sample= | ||
| − | < | + | <source lang="C" highlight="3"> |
| − | void finish_media(uint64_t media) | + | void finish_media( uint64_t media ) |
{ | { | ||
| − | truxton_media_set_status(media, MEDIA_STATUS_LOADED); | + | truxton_media_set_status( media, MEDIA_STATUS_LOADED ); |
} | } | ||
| − | </ | + | </source> |
Latest revision as of 07:36, 3 February 2024
This sets the status of the media.
It corresponds to the [MediaStatusID] column of the [Media] table.
It can be one of the defined constants but it must be one of the values in the [ID] column of the [MediaStatus] table.
Syntax
void truxton_media_set_status( uint64_t media_handle, uint64_t status );
Parameters
media_handle
The handle created by the truxton_media_open_id or truxton_media_create call.
status
The status of the media.
Sample
void finish_media( uint64_t media )
{
truxton_media_set_status( media, MEDIA_STATUS_LOADED );
}
