1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
|
.. warning::
TorchAudio's C++ API is a prototype feature.
API/ABI backward compatibility is not guaranteed.
.. note::
The top-level namespace has been changed from ``torchaudio`` to ``torio``.
``StreamReader`` has been renamed to ``StreamingMediaDecoder``.
torio::io::StreamingMediaDecoder
================================
``StreamingMediaDecoder`` is the implementation used by Python equivalent and provides similar interface.
When working with custom I/O, such as in-memory data, ``StreamingMediaDecoderCustomIO`` class can be used.
Both classes have the same methods defined, so their usages are the same.
Constructors
------------
StreamingMediaDecoder
^^^^^^^^^^^^^^^^^^^^^
.. doxygenclass:: torio::io::StreamingMediaDecoder
.. doxygenfunction:: torio::io::StreamingMediaDecoder::StreamingMediaDecoder(const std::string &src, const std::optional<std::string> &format = {}, const c10::optional<OptionDict> &option = {})
StreamingMediaDecoderCustomIO
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. doxygenclass:: torio::io::StreamingMediaDecoderCustomIO
.. doxygenfunction:: torio::io::StreamingMediaDecoderCustomIO::StreamingMediaDecoderCustomIO
Query Methods
-------------
find_best_audio_stream
^^^^^^^^^^^^^^^^^^^^^^
.. doxygenfunction:: torio::io::StreamingMediaDecoder::find_best_audio_stream
find_best_video_stream
^^^^^^^^^^^^^^^^^^^^^^
.. doxygenfunction:: torio::io::StreamingMediaDecoder::find_best_video_stream
get_metadata
^^^^^^^^^^^^
.. doxygenfunction:: torio::io::StreamingMediaDecoder::get_metadata
num_src_streams
^^^^^^^^^^^^^^^
.. doxygenfunction:: torio::io::StreamingMediaDecoder::num_src_streams
get_src_stream_info
^^^^^^^^^^^^^^^^^^^
.. doxygenfunction:: torio::io::StreamingMediaDecoder::get_src_stream_info
num_out_streams
^^^^^^^^^^^^^^^
.. doxygenfunction:: torio::io::StreamingMediaDecoder::num_out_streams
get_out_stream_info
^^^^^^^^^^^^^^^^^^^
.. doxygenfunction:: torio::io::StreamingMediaDecoder::get_out_stream_info
is_buffer_ready
^^^^^^^^^^^^^^^
.. doxygenfunction:: torio::io::StreamingMediaDecoder::is_buffer_ready
Configure Methods
-----------------
add_audio_stream
^^^^^^^^^^^^^^^^
.. doxygenfunction:: torio::io::StreamingMediaDecoder::add_audio_stream
add_video_stream
^^^^^^^^^^^^^^^^
.. doxygenfunction:: torio::io::StreamingMediaDecoder::add_video_stream
remove_stream
^^^^^^^^^^^^^
.. doxygenfunction:: torio::io::StreamingMediaDecoder::remove_stream
Stream Methods
^^^^^^^^^^^^^^
seek
^^^^
.. doxygenfunction:: torio::io::StreamingMediaDecoder::seek
process_packet
^^^^^^^^^^^^^^
.. doxygenfunction:: torio::io::StreamingMediaDecoder::process_packet()
process_packet_block
^^^^^^^^^^^^^^^^^^^^
.. doxygenfunction:: torio::io::StreamingMediaDecoder::process_packet_block
process_all_packets
^^^^^^^^^^^^^^^^^^^
.. doxygenfunction:: torio::io::StreamingMediaDecoder::process_all_packets
fill_buffer
^^^^^^^^^^^
.. doxygenfunction:: torio::io::StreamingMediaDecoder::fill_buffer
Retrieval Methods
-----------------
pop_chunks
^^^^^^^^^^
.. doxygenfunction:: torio::io::StreamingMediaDecoder::pop_chunks
Support Structures
------------------
Chunk
^^^^^
.. container:: py attribute
.. doxygenstruct:: torio::io::Chunk
:members:
SrcStreaminfo
^^^^^^^^^^^^^
.. container:: py attribute
.. doxygenstruct:: torio::io::SrcStreamInfo
:members:
OutputStreaminfo
^^^^^^^^^^^^^^^^
.. container:: py attribute
.. doxygenstruct:: torio::io::OutputStreamInfo
:members:
|