diff --git a/av/packet.py b/av/packet.py index 09bd0e1bd..5a97817e3 100644 --- a/av/packet.py +++ b/av/packet.py @@ -446,7 +446,7 @@ def has_sidedata(self, dtype: str) -> bool: def get_sidedata(self, dtype: str) -> PacketSideData: """get a copy of the side data - :param dtype: side data type (:method:`~av.packet.PacketSideData.sidedata_types` for the full list of options) + :param dtype: side data type (:meth:`~av.packet.PacketSideData.sidedata_types` for the full list of options) :type dtype: str :return: newly created copy of the side data if the side data of the requested type is found in the packet, else an empty object diff --git a/av/subtitles/subtitle.py b/av/subtitles/subtitle.py index 90eef433f..83f8041a1 100644 --- a/av/subtitles/subtitle.py +++ b/av/subtitles/subtitle.py @@ -47,21 +47,18 @@ def create( """ Create a SubtitleSet for encoding. - Args: - text: The subtitle text in ASS dialogue format - (e.g. b"0,0,Default,,0,0,0,,Hello World") - start: Start display time as offset from pts (typically 0) - end: End display time as offset from pts (i.e., duration) - pts: Presentation timestamp in stream time_base units - subtitle_format: Subtitle format (default 1 for text) - - Note: + :param text: The subtitle text in ASS dialogue format + (e.g. ``b"0,0,Default,,0,0,0,,Hello World"``) + :param start: Start display time as offset from pts (typically 0) + :param end: End display time as offset from pts (i.e., duration) + :param pts: Presentation timestamp in stream time_base units + :param subtitle_format: Subtitle format (default 1 for text) + :return: A SubtitleSet ready for encoding + + .. note:: All timing values should be in stream time_base units. For MKV (time_base=1/1000), units are milliseconds. For MP4 (time_base=1/1000000), units are microseconds. - - Returns: - A SubtitleSet ready for encoding """ subset: SubtitleSet = SubtitleSet(_cinit_bypass_sentinel) diff --git a/docs/overview/installation.rst b/docs/overview/installation.rst index 35da507d8..b4399ba48 100644 --- a/docs/overview/installation.rst +++ b/docs/overview/installation.rst @@ -27,7 +27,9 @@ Bring your own FFmpeg PyAV can also be compiled against your own build of FFmpeg (version ``8.0`` or higher). You can force installing PyAV from source by running: .. code-block:: bash + pip install av --no-binary av + PyAV depends upon several libraries from FFmpeg: - ``libavcodec``