<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
<!ENTITY pi "&#960;">
<!ENTITY solidus "&#8260;">
]>
<refentry id="GtkMediaFile">
<refmeta>
<refentrytitle role="top_of_page" id="GtkMediaFile.top_of_page">GtkMediaFile</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK4 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GtkMediaFile</refname>
<refpurpose>Open media files for use in GTK</refpurpose>
</refnamediv>

<refsect1 id="GtkMediaFile.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_proto_type" colwidth="150px"/>
<colspec colname="functions_proto_name"/>
<tbody>
<row><entry role="function_type"><link linkend="GtkMediaStream"><returnvalue>GtkMediaStream</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-media-file-new">gtk_media_file_new</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GtkMediaStream"><returnvalue>GtkMediaStream</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-media-file-new-for-filename">gtk_media_file_new_for_filename</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GtkMediaStream"><returnvalue>GtkMediaStream</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-media-file-new-for-resource">gtk_media_file_new_for_resource</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GtkMediaStream"><returnvalue>GtkMediaStream</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-media-file-new-for-file">gtk_media_file_new_for_file</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GtkMediaStream"><returnvalue>GtkMediaStream</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-media-file-new-for-input-stream">gtk_media_file_new_for_input_stream</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-media-file-clear">gtk_media_file_clear</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-media-file-set-filename">gtk_media_file_set_filename</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-media-file-set-resource">gtk_media_file_set_resource</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-media-file-set-file">gtk_media_file_set_file</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GFile"><returnvalue>GFile</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-media-file-get-file">gtk_media_file_get_file</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-media-file-set-input-stream">gtk_media_file_set_input_stream</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GInputStream"><returnvalue>GInputStream</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-media-file-get-input-stream">gtk_media_file_get_input_stream</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkMediaFile.properties" role="properties">
<title role="properties.title">Properties</title>
<informaltable frame="none">
<tgroup cols="3">
<colspec colname="properties_type" colwidth="150px"/>
<colspec colname="properties_name" colwidth="300px"/>
<colspec colname="properties_flags" colwidth="200px"/>
<tbody>
<row><entry role="property_type"><link linkend="GFile"><type>GFile</type></link>&#160;*</entry><entry role="property_name"><link linkend="GtkMediaFile--file">file</link></entry><entry role="property_flags">Read / Write</entry></row>
<row><entry role="property_type"><link linkend="GInputStream"><type>GInputStream</type></link>&#160;*</entry><entry role="property_name"><link linkend="GtkMediaFile--input-stream">input-stream</link></entry><entry role="property_flags">Read / Write</entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkMediaFile.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="other_proto_type" colwidth="150px"/>
<colspec colname="other_proto_name"/>
<tbody>
<row><entry role="datatype_keyword"></entry><entry role="function_name"><link linkend="GtkMediaFile-struct">GtkMediaFile</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkMediaFile.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen>    <link linkend="GObject">GObject</link>
    <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> <link linkend="GtkMediaStream">GtkMediaStream</link>
        <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> GtkMediaFile
</screen>
</refsect1>
<refsect1 id="GtkMediaFile.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GtkMediaFile implements
 <link linkend="GdkPaintable">GdkPaintable</link>.</para>

</refsect1>

<refsect1 id="GtkMediaFile.includes"><title>Includes</title><synopsis>#include &lt;gtk/gtk.h&gt;
</synopsis></refsect1>

<refsect1 id="GtkMediaFile.description" role="desc">
<title role="desc.title">Description</title>
<para><link linkend="GtkMediaFile"><type>GtkMediaFile</type></link> is the implementation for media file usage with <link linkend="GtkMediaStream"><type>GtkMediaStream</type></link>.</para>
<para>This provides a simple way to play back video files with GTK.</para>
<para>GTK+ provides a GIO extension point for <link linkend="GtkMediaFile"><type>GtkMediaFile</type></link> implementations
to allow for external implementations using various media frameworks.
GTK+ itself includes implementations using GStreamer and ffmpeg.</para>

</refsect1>
<refsect1 id="GtkMediaFile.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="gtk-media-file-new" role="function">
<title>gtk_media_file_new&#160;()</title>
<indexterm zone="gtk-media-file-new"><primary>gtk_media_file_new</primary></indexterm>
<programlisting language="C"><link linkend="GtkMediaStream"><returnvalue>GtkMediaStream</returnvalue></link>&#160;*
gtk_media_file_new (<parameter><type>void</type></parameter>);</programlisting>
<para>Creates a new empty media file.</para>
<refsect3 id="gtk-media-file-new.returns" role="returns">
<title>Returns</title>
<para>a new <link linkend="GtkMediaFile"><type>GtkMediaFile</type></link>. </para>
<para><emphasis role="annotation">[<acronym>type</acronym> Gtk.MediaFile]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-media-file-new-for-filename" role="function">
<title>gtk_media_file_new_for_filename&#160;()</title>
<indexterm zone="gtk-media-file-new-for-filename"><primary>gtk_media_file_new_for_filename</primary></indexterm>
<programlisting language="C"><link linkend="GtkMediaStream"><returnvalue>GtkMediaStream</returnvalue></link>&#160;*
gtk_media_file_new_for_filename (<parameter>const <link linkend="char"><type>char</type></link> *filename</parameter>);</programlisting>
<para>This is a utility function that converts the given <parameter>filename</parameter>

to a <link linkend="GFile"><type>GFile</type></link> and calls <link linkend="gtk-media-file-new-for-file"><function>gtk_media_file_new_for_file()</function></link>.</para>
<refsect3 id="gtk-media-file-new-for-filename.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>filename</para></entry>
<entry role="parameter_description"><para>filename to open</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-media-file-new-for-filename.returns" role="returns">
<title>Returns</title>
<para>a new <link linkend="GtkMediaFile"><type>GtkMediaFile</type></link> playing <parameter>filename</parameter>
. </para>
<para><emphasis role="annotation">[<acronym>type</acronym> Gtk.MediaFile]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-media-file-new-for-resource" role="function">
<title>gtk_media_file_new_for_resource&#160;()</title>
<indexterm zone="gtk-media-file-new-for-resource"><primary>gtk_media_file_new_for_resource</primary></indexterm>
<programlisting language="C"><link linkend="GtkMediaStream"><returnvalue>GtkMediaStream</returnvalue></link>&#160;*
gtk_media_file_new_for_resource (<parameter>const <link linkend="char"><type>char</type></link> *resource_path</parameter>);</programlisting>
<para>This is a utility function that converts the given <parameter>resource</parameter>

to a <link linkend="GFile"><type>GFile</type></link> and calls <link linkend="gtk-media-file-new-for-file"><function>gtk_media_file_new_for_file()</function></link>.</para>
<refsect3 id="gtk-media-file-new-for-resource.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>resource_path</para></entry>
<entry role="parameter_description"><para>resource path to open</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-media-file-new-for-resource.returns" role="returns">
<title>Returns</title>
<para>a new <link linkend="GtkMediaFile"><type>GtkMediaFile</type></link> playing <parameter>resource_path</parameter>
. </para>
<para><emphasis role="annotation">[<acronym>type</acronym> Gtk.MediaFile]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-media-file-new-for-file" role="function">
<title>gtk_media_file_new_for_file&#160;()</title>
<indexterm zone="gtk-media-file-new-for-file"><primary>gtk_media_file_new_for_file</primary></indexterm>
<programlisting language="C"><link linkend="GtkMediaStream"><returnvalue>GtkMediaStream</returnvalue></link>&#160;*
gtk_media_file_new_for_file (<parameter><link linkend="GFile"><type>GFile</type></link> *file</parameter>);</programlisting>
<para>Creates a new media file to play <parameter>file</parameter>
.</para>
<refsect3 id="gtk-media-file-new-for-file.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>file</para></entry>
<entry role="parameter_description"><para>The file to play</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-media-file-new-for-file.returns" role="returns">
<title>Returns</title>
<para>a new <link linkend="GtkMediaFile"><type>GtkMediaFile</type></link> playing <parameter>file</parameter>
. </para>
<para><emphasis role="annotation">[<acronym>type</acronym> Gtk.MediaFile]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-media-file-new-for-input-stream" role="function">
<title>gtk_media_file_new_for_input_stream&#160;()</title>
<indexterm zone="gtk-media-file-new-for-input-stream"><primary>gtk_media_file_new_for_input_stream</primary></indexterm>
<programlisting language="C"><link linkend="GtkMediaStream"><returnvalue>GtkMediaStream</returnvalue></link>&#160;*
gtk_media_file_new_for_input_stream (<parameter><link linkend="GInputStream"><type>GInputStream</type></link> *stream</parameter>);</programlisting>
<para>Creates a new media file to play <parameter>stream</parameter>
. If you want the
resulting media to be seekable, the stream should implement
the <link linkend="GSeekable"><type>GSeekable</type></link> interface.</para>
<refsect3 id="gtk-media-file-new-for-input-stream.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>stream</para></entry>
<entry role="parameter_description"><para>The stream to play</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-media-file-new-for-input-stream.returns" role="returns">
<title>Returns</title>
<para>a new <link linkend="GtkMediaFile"><type>GtkMediaFile</type></link>. </para>
<para><emphasis role="annotation">[<acronym>type</acronym> Gtk.MediaFile]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-media-file-clear" role="function">
<title>gtk_media_file_clear&#160;()</title>
<indexterm zone="gtk-media-file-clear"><primary>gtk_media_file_clear</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_media_file_clear (<parameter><link linkend="GtkMediaFile"><type>GtkMediaFile</type></link> *self</parameter>);</programlisting>
<para>Resets the media file to be empty.</para>
<refsect3 id="gtk-media-file-clear.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkMediaFile"><type>GtkMediaFile</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-media-file-set-filename" role="function">
<title>gtk_media_file_set_filename&#160;()</title>
<indexterm zone="gtk-media-file-set-filename"><primary>gtk_media_file_set_filename</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_media_file_set_filename (<parameter><link linkend="GtkMediaFile"><type>GtkMediaFile</type></link> *self</parameter>,
                             <parameter>const <link linkend="char"><type>char</type></link> *filename</parameter>);</programlisting>
<para>This is a utility function that converts the given <parameter>filename</parameter>

to a <link linkend="GFile"><type>GFile</type></link> and calls <link linkend="gtk-media-file-set-file"><function>gtk_media_file_set_file()</function></link>.</para>
<refsect3 id="gtk-media-file-set-filename.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkMediaFile"><type>GtkMediaFile</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>filename</para></entry>
<entry role="parameter_description"><para>name of file to play. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-media-file-set-resource" role="function">
<title>gtk_media_file_set_resource&#160;()</title>
<indexterm zone="gtk-media-file-set-resource"><primary>gtk_media_file_set_resource</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_media_file_set_resource (<parameter><link linkend="GtkMediaFile"><type>GtkMediaFile</type></link> *self</parameter>,
                             <parameter>const <link linkend="char"><type>char</type></link> *resource_path</parameter>);</programlisting>
<para>This is a utility function that converts the given <parameter>resource_path</parameter>

to a <link linkend="GFile"><type>GFile</type></link> and calls <link linkend="gtk-media-file-set-file"><function>gtk_media_file_set_file()</function></link>.</para>
<refsect3 id="gtk-media-file-set-resource.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkMediaFile"><type>GtkMediaFile</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>resource_path</para></entry>
<entry role="parameter_description"><para>path to resource to play. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-media-file-set-file" role="function">
<title>gtk_media_file_set_file&#160;()</title>
<indexterm zone="gtk-media-file-set-file"><primary>gtk_media_file_set_file</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_media_file_set_file (<parameter><link linkend="GtkMediaFile"><type>GtkMediaFile</type></link> *self</parameter>,
                         <parameter><link linkend="GFile"><type>GFile</type></link> *file</parameter>);</programlisting>
<para>If any file is still playing, stop playing it.</para>
<para>Then start playing the given <parameter>file</parameter>
.</para>
<refsect3 id="gtk-media-file-set-file.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkMediaFile"><type>GtkMediaFile</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>file</para></entry>
<entry role="parameter_description"><para>the file to play. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-media-file-get-file" role="function">
<title>gtk_media_file_get_file&#160;()</title>
<indexterm zone="gtk-media-file-get-file"><primary>gtk_media_file_get_file</primary></indexterm>
<programlisting language="C"><link linkend="GFile"><returnvalue>GFile</returnvalue></link>&#160;*
gtk_media_file_get_file (<parameter><link linkend="GtkMediaFile"><type>GtkMediaFile</type></link> *self</parameter>);</programlisting>
<para>Returns the file that <parameter>self</parameter>
 is currently playing from.</para>
<para>When <parameter>self</parameter>
 is not playing or not playing from a file,
<link linkend="NULL:CAPS"><literal>NULL</literal></link> is returned.</para>
<refsect3 id="gtk-media-file-get-file.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkMediaFile"><type>GtkMediaFile</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-media-file-get-file.returns" role="returns">
<title>Returns</title>
<para>The currently playing file or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if not
playing from a file. </para>
<para><emphasis role="annotation">[<acronym>nullable</acronym>][<acronym>transfer none</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-media-file-set-input-stream" role="function">
<title>gtk_media_file_set_input_stream&#160;()</title>
<indexterm zone="gtk-media-file-set-input-stream"><primary>gtk_media_file_set_input_stream</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_media_file_set_input_stream (<parameter><link linkend="GtkMediaFile"><type>GtkMediaFile</type></link> *self</parameter>,
                                 <parameter><link linkend="GInputStream"><type>GInputStream</type></link> *stream</parameter>);</programlisting>
<para>If anything is still playing, stop playing it. Then start
playing the given <parameter>stream</parameter>
.</para>
<para>Full control about the <parameter>stream</parameter>
 is assumed for the duration of
playback. The stream will not bt be closed.</para>
<refsect3 id="gtk-media-file-set-input-stream.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkMediaFile"><type>GtkMediaFile</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>stream</para></entry>
<entry role="parameter_description"><para>the stream to play from. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-media-file-get-input-stream" role="function">
<title>gtk_media_file_get_input_stream&#160;()</title>
<indexterm zone="gtk-media-file-get-input-stream"><primary>gtk_media_file_get_input_stream</primary></indexterm>
<programlisting language="C"><link linkend="GInputStream"><returnvalue>GInputStream</returnvalue></link>&#160;*
gtk_media_file_get_input_stream (<parameter><link linkend="GtkMediaFile"><type>GtkMediaFile</type></link> *self</parameter>);</programlisting>
<para>Returns the stream that <parameter>self</parameter>
 is currently playing from.</para>
<para>When <parameter>self</parameter>
 is not playing or not playing from a stream,
<link linkend="NULL:CAPS"><literal>NULL</literal></link> is returned.</para>
<refsect3 id="gtk-media-file-get-input-stream.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkMediaFile"><type>GtkMediaFile</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-media-file-get-input-stream.returns" role="returns">
<title>Returns</title>
<para>The currently playing stream or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if not
playing from a stream. </para>
<para><emphasis role="annotation">[<acronym>nullable</acronym>][<acronym>transfer none</acronym>]</emphasis></para>
</refsect3></refsect2>

</refsect1>
<refsect1 id="GtkMediaFile.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="GtkMediaFile-struct" role="struct">
<title>GtkMediaFile</title>
<indexterm zone="GtkMediaFile-struct"><primary>GtkMediaFile</primary></indexterm>
<programlisting language="C">typedef struct _GtkMediaFile GtkMediaFile;</programlisting>
</refsect2>

</refsect1>
<refsect1 id="GtkMediaFile.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GtkMediaFile--file" role="property"><title>The <literal>“file”</literal> property</title>
<indexterm zone="GtkMediaFile--file"><primary>GtkMediaFile:file</primary></indexterm>
<programlisting>  “file”                     <link linkend="GFile"><type>GFile</type></link>&#160;*</programlisting>
<para>The file being played back or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if not playing a file.</para>
<para>Owner: GtkMediaFile</para>
<para>Flags: Read / Write</para>
</refsect2>
<refsect2 id="GtkMediaFile--input-stream" role="property"><title>The <literal>“input-stream”</literal> property</title>
<indexterm zone="GtkMediaFile--input-stream"><primary>GtkMediaFile:input-stream</primary></indexterm>
<programlisting>  “input-stream”             <link linkend="GInputStream"><type>GInputStream</type></link>&#160;*</programlisting>
<para>The stream being played back or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if not playing a stream, like when playing a file.</para>
<para>Owner: GtkMediaFile</para>
<para>Flags: Read / Write</para>
</refsect2>

</refsect1>
<refsect1 id="GtkMediaFile.see-also">
<title>See Also</title>
<para><link linkend="GtkMediaStream"><type>GtkMediaStream</type></link>, <link linkend="GtkVideo"><type>GtkVideo</type></link></para>

</refsect1>

</refentry>
