diff options
author | Lorenz Diener <[email protected]> | 2019-05-11 01:00:11 +0200 |
---|---|---|
committer | Lorenz Diener <[email protected]> | 2019-05-11 01:00:11 +0200 |
commit | 5f792c8bd843ab0fbde01264225ebe2f03d01302 (patch) | |
tree | 1136bd48a77e38cb85ebcdee944969497f150d4b | |
parent | bf61d4881ec4cb7ab2e73a21da2349c681e371a5 (diff) | |
download | mastodon.py-5f792c8bd843ab0fbde01264225ebe2f03d01302.tar.gz |
Document blurhash
-rw-r--r-- | docs/index.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst index 9988a5f..96a0665 100644 --- a/docs/index.rst +++ b/docs/index.rst | |||
@@ -553,6 +553,7 @@ Media dicts | |||
553 | # rounded), and a "length" field giving a videos length in a human-readable format. | 553 | # rounded), and a "length" field giving a videos length in a human-readable format. |
554 | # Note that a video may have an image as preview. | 554 | # Note that a video may have an image as preview. |
555 | # May also contain a 'focus' dict. | 555 | # May also contain a 'focus' dict. |
556 | 'blurhash': # The blurhash for the image, used for preview / placeholder generation | ||
556 | } | 557 | } |
557 | 558 | ||
558 | # Metadata dicts (image) - all fields are optional: | 559 | # Metadata dicts (image) - all fields are optional: |
@@ -1063,6 +1064,12 @@ These functions allow for convenient retrieval of paginated data. | |||
1063 | .. automethod:: Mastodon.fetch_previous | 1064 | .. automethod:: Mastodon.fetch_previous |
1064 | .. automethod:: Mastodon.fetch_remaining | 1065 | .. automethod:: Mastodon.fetch_remaining |
1065 | 1066 | ||
1067 | Blurhash decoding | ||
1068 | ----------------- | ||
1069 | This function allows for easy basic decoding of blurhash strings to images. | ||
1070 | |||
1071 | .. automethod:: Mastodon.decode_blurhash | ||
1072 | |||
1066 | Streaming | 1073 | Streaming |
1067 | --------- | 1074 | --------- |
1068 | These functions allow access to the streaming API. | 1075 | These functions allow access to the streaming API. |