Difference between revisions of "Truxton media get status"
Jump to navigation
Jump to search
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
This retrieves the [[Media Status|status]] of the media. | This retrieves 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"> |
uint64_t truxton_media_get_status( uint64_t media_handle ); | uint64_t truxton_media_get_status( uint64_t media_handle ); | ||
| − | </ | + | </source> |
=Parameters= | =Parameters= | ||
| Line 16: | Line 16: | ||
=Sample= | =Sample= | ||
| − | < | + | <source lang="C" highlight="3"> |
| − | void print_status(uint64_t media) | + | void print_status( uint64_t media ) |
{ | { | ||
uint64_t status = truxton_media_get_status( media ); | uint64_t status = truxton_media_get_status( media ); | ||
| Line 30: | Line 30: | ||
} | } | ||
} | } | ||
| − | </ | + | </source> |
Latest revision as of 07:35, 3 February 2024
This retrieves 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
uint64_t truxton_media_get_status( uint64_t media_handle );
Parameters
media_handle
The handle created by the truxton_media_open_id or truxton_media_create call.
Return value
The status of the media.
Sample
void print_status( uint64_t media )
{
uint64_t status = truxton_media_get_status( media );
if ( status == MEDIA_STATUS_LOADED )
{
printf( "The media has finished loading.\n" );
}
else
{
printf( "The media is not done.\n" );
}
}
