Difference between revisions of "Truxton media set percent complete"

From truxwiki.com
Jump to navigation Jump to search
(Created page with "Sets the percentage complete the media is in the processing phase. This corresponds to the <code>PercentComplete</code> column of the <code>Media</code> table. =Syntax= <synt...")
 
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
Sets the percentage complete the media is in the processing phase.
 
Sets the percentage complete the media is in the processing phase.
This corresponds to the <code>PercentComplete</code> column of the <code>Media</code> table.
+
This corresponds to the <code>[PercentComplete]</code> column of the <code><nowiki>[</nowiki>[[Media Table|Media]]<nowiki>]</nowiki></code> table.
  
 
=Syntax=
 
=Syntax=
<syntaxhighlight lang="C">
+
<source lang="C">
 
void truxton_media_set_percent_complete( uint64_t media_handle, uint64_t percent_complete );
 
void truxton_media_set_percent_complete( uint64_t media_handle, uint64_t percent_complete );
</syntaxhighlight>
+
</source>
  
 
=Parameters=
 
=Parameters=
Line 17: Line 17:
  
 
=Sample=
 
=Sample=
<syntaxhighlight lang="C" highlight="3">
+
<source lang="C" highlight="3">
void set_done(uint64_t media_handle)
+
void set_done( uint64_t media_handle )
 
{
 
{
 
   truxton_media_set_percent_complete( media_handle, 100 );
 
   truxton_media_set_percent_complete( media_handle, 100 );
 
}
 
}
</syntaxhighlight>
+
</source>

Latest revision as of 07:49, 3 February 2024

Sets the percentage complete the media is in the processing phase. This corresponds to the [PercentComplete] column of the [Media] table.

Syntax

void truxton_media_set_percent_complete( uint64_t media_handle, uint64_t percent_complete );

Parameters

media_handle

The handle created by the truxton_media_create or truxton_media_open_id call.

percent_complete

How far along the processing is. This value will be capped at 100. If you send in a value larger than 100, it will go into the database as 100.

Sample

void set_done( uint64_t media_handle )
{
   truxton_media_set_percent_complete( media_handle, 100 );
}