From b01edc49ee8831bb91d8e79eac5be8b8fb97af44 Mon Sep 17 00:00:00 2001 From: Lorenz Diener Date: Tue, 17 Apr 2018 16:15:54 +0200 Subject: Improve docs again --- docs/index.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/index.rst b/docs/index.rst index 4de0f6e..eebe893 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -731,7 +731,8 @@ If `async` is True, the listener will listen on another thread and these methods will return a handle corresponding to the open connection. If, in addition, `async_reconnect` is True, the thread will attempt to reconnect to the streaming API if any errors are encountered, waiting `async_reconnect_wait_sec` seconds between reconnection attempts. Note that no effort is made -to "catch up" - toots made while the connection is broken will not be received. +to "catch up" - events created while the connection is broken will not be received. If you need to make +sure to get absolutely all notifications / deletes / toots, you will have to do that manually. The connection may be closed at any time by calling the handles close() method. The current status of the handler thread can be checked with the handles is_alive() function, -- cgit v1.2.3 From 5f44998dd201beb871f06c0813b3dc69d387f7da Mon Sep 17 00:00:00 2001 From: Lorenz Diener Date: Tue, 17 Apr 2018 17:49:08 +0200 Subject: First steps to 2.3.0 support --- docs/index.rst | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/index.rst b/docs/index.rst index eebe893..436d7cc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -385,10 +385,13 @@ Media dicts 'preview_url': # The URL for the media preview 'text_url': # The display text for the media (what shows up in toots) 'meta': # Dictionary of two image metadata dicts (see below), - # 'original' and 'small' (preview) + # 'original' and 'small' (preview). Either may be empty. + # May additionally contain an "fps" field giving a videos frames per second (possibly + # rounded), and a "length" field giving a videos length in a human-readable format. + # Note that a video may have an image as preview. } - # Metadata dicts: + # Metadata dicts (image) - all fields are optional: { 'width': # Width of the image in pixels 'height': # Height of the image in pixels @@ -396,6 +399,14 @@ Media dicts 'size': # Textual representation of the image size in pixels, e.g. '800x600' } + # Metadata dicts (video, gifv) - all fields are optional: + { + 'width': # Width of the video in pixels + 'heigh': # Height of the video in pixels + 'frame_rate': # Exact frame rate of the video in frames per second + 'duration': # Duration of the video in seconds + 'bitrate': # Average bit-rate of the video in bytes per second + } Card dicts ~~~~~~~~~~ .. _card dict: @@ -452,6 +463,8 @@ Instance dicts 'version': # The instances mastodon version 'urls': # Additional URLs dict, presently only 'streaming_api' with the # stream websocket address. + 'contact_account': # Account dict of the primary contact for the instance. + 'languages': # Array of ISO 6391 language codes the instance has chosen to advertise. } Activity dicts -- cgit v1.2.3