Truxton media get status - Revision history

Sam at 11:35, 3 February 2024

2024-02-03T11:35:45Z

Sam at 03:47, 10 February 2021

2021-02-10T03:47:21Z

Sam at 11:07, 14 December 2020

2020-12-14T11:07:55Z

Sam: /* Sample */

2020-07-25T11:52:14Z

Sample

Sam at 14:18, 11 July 2020

2020-07-11T14:18:06Z

Sam: Created page with "This retrieves the status of the media. It corresponds to the `MediaStatusID` column of the `Media` table. It can be one of the Media..."

2020-07-11T14:13:50Z

Created page with "This retrieves 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..."

New page

This retrieves the [[Media Status|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 Status|defined constants]] but it must be one of the values in the <code>ID</code> column of the <code>MediaStatus</code> table.

=Syntax=
<syntaxhighlight lang="C">
uint64_t truxton_media_get_status( uint64_t media_handle );
</syntaxhighlight>

=Parameters=
==<code>media_handle</code>==
The handle created by the [[truxton_media_open_id]] or [[truxton_media_create]] call.

=Return value=
The [[Media Status|status] of the media.

=Sample=
<syntaxhighlight lang="C" line highlight="3">
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" );
}
}
</syntaxhighlight>

@@ Line 1: / Line 1: @@
 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.

@@ Line 17: / Line 17: @@
 =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 );

@@ Line 1: / Line 1: @@
 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>[Media]</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=
-<syntaxhighlight lang="C">
+<source lang="C">
 uint64_t truxton_media_get_status( uint64_t media_handle );
-</syntaxhighlight>
+</source>
 =Parameters=
@@ Line 16: / Line 16: @@
 =Sample=
-<syntaxhighlight lang="C" highlight="3">
+<source lang="C" highlight="3">
 void print_status(uint64_t media)
+{
@@ Line 30: / Line 30: @@
+    }
+}
-</syntaxhighlight>
+</source>

@@ Line 13: / Line 13: @@
 =Return value=
-The [[Media Status|status] of the media.
+The [[Media Status|status]] of the media.
 =Sample=