Examples.xml

<page>
    <h1>Examples</h1>
    <text>
        This page contains example scripts to demonstrate how PyTgCalls looks like.

        Every script is working right away (assuming you correctly set up your credentials), meaning you can simply copy-paste them
        and run. The only things you have to modify are session names and target chats, where applicable.

        The examples listed below can be treated as building blocks for your own applications and are designed to be simple enough
        to give you a basic idea.
    </text>
    <separator/>
    <table>
        <definitions>
            <column>Example</column>
            <column>Description</column>
        </definitions>
        <item>
            <column><ref-shi url="example/additional_ffmpeg_parameters/additional_ffmpeg_parameters.py">additional_ffmpeg_parameters</ref-shi></column>
            <column>Append parameters to ffmpeg</column>
        </item>
        <item>
            <column><ref-shi url="example/bridged_calls/example_bridged.py">bridged_calls</ref-shi></column>
            <column>Create a bridge between two group calls</column>
        </item>
        <item>
            <column><ref-shi url="example/capture_mic/example_mic.py">capture_mic</ref-shi></column>
            <column>Capture microphone</column>
        </item>
        <item>
            <column><ref-shi url="example/custom_api/example_api.py">custom_api</ref-shi></column>
            <column>Use custom API server to bind PHP or other API to PyTgCalls</column>
        </item>
        <item>
            <column><ref-shi url="example/custom_filters/example_custom.py">custom_filters</ref-shi></column>
            <column>Make custom filters to use it in PyTgCalls</column>
        </item>
        <item>
            <column><ref-shi url="example/docker_example/docker_example.py">docker_example</ref-shi></column>
            <column>Run PyTgCalls in Docker image</column>
        </item>
        <item>
            <column><ref-shi url="example/external_capture/example_external.py">external_capture</ref-shi></column>
            <column>Capture audio and video frames and receive them as updates</column>
        </item>
        <item>
            <column><ref-shi url="example/fifo_conversion/example_fifo.py">fifo_conversion</ref-shi></column>
            <column>Play a stream from fifo</column>
        </item>
        <item>
            <column><ref-shi url="example/frame_sending/example_frame_sending.py">frame_sending</ref-shi></column>
            <column>Send audio frames manually from Python directly.</column>
        </item>
        <item>
            <column><ref-shi url="example/multiple_clients/example_multiple.py">multiple_clients</ref-shi></column>
            <column>Use multiple clients in one script</column>
        </item>
        <item>
            <column><ref-shi url="example/p2p_example/example_p2p.py">p2p_example</ref-shi></column>
            <column>Play a stream from a private call using PyTgCalls</column>
        </item>
        <item>
            <column><ref-shi url="example/piped_audio_calls/example_piped_audio.py">piped_audio_calls</ref-shi></column>
            <column>Play audio using ffmpeg for live conversion (with integrated ffmpeg)</column>
        </item>
        <item>
            <column><ref-shi url="example/piped_image_calls/example_piped_image.py">piped_image_calls</ref-shi></column>
            <column>Play audio and image using ffmpeg for live conversion (with integrated ffmpeg)</column>
        </item>
        <item>
            <column><ref-shi url="example/raw_streaming/example_video.py">raw_streaming</ref-shi></column>
            <column>Play PCM16L and RAW_VIDEO from disk</column>
        </item>
        <item>
            <column><ref-shi url="example/remote_piped_play/example_remote_piped.py">remote_piped_play</ref-shi></column>
            <column>Play a stream from a remote link using ffmpeg for live conversion (with integrated ffmpeg)</column>
        </item>
        <item>
            <column><ref-shi url="example/remote_stream_with_header/remote_stream_with_header.py">remote_stream_with_header</ref-shi></column>
            <column>Play a stream from a remote link using ffmpeg for live conversion (with integrated ffmpeg) with additional headers</column>
        </item>
        <item>
            <column><ref-shi url="example/screen_sharing/example_desktop.py">screen_sharing</ref-shi></column>
            <column>Screen sharing</column>
        </item>
        <item>
            <column><ref-shi url="example/screen_sharing_mic/example_desktop_mic.py">screen_sharing_mic</ref-shi></column>
            <column>Screen sharing with microphone</column>
        </item>
        <item>
            <column><ref-shi url="example/simple_calls/example_simple.py">simple_calls</ref-shi></column>
            <column>A simple example about using PyTgCalls with High Level Methods</column>
        </item>
        <item>
            <column><ref-shi url="example/telethon_example/example_telethon.py">telethon_example</ref-shi></column>
            <column>A simple example about using PyTgCalls with Telethon</column>
        </item>
        <item>
            <column><ref-shi url="example/video_calls/example_piped_video.py">video_calls</ref-shi></column>
            <column>Play audio and video using ffmpeg for live conversion (with integrated ffmpeg)</column>
        </item>
        <item>
            <column><ref-shi url="example/whisper_transcription/example_transcription.py">whisper_transcription</ref-shi></column>
            <column>Transcribe audio from a group call or a private call using Whisper AI</column>
        </item>
        <item>
            <column><ref-shi url="example/youtube_dl/youtube_dl_example.py">youtube_dl</ref-shi></column>
            <column>Example usage of PyTgCalls with YoutubeDL</column>
        </item>
    </table>
</page>