.. _objects:

=======
Objects
=======

broadcaster
-----------
type: ``string``

name of the broadcaster

media
-----
type: ``object``

* (``number``) ``id``: unique ID of media set
* (``string``) ``type``: "photos" or "video"
* (``string``) ``name``: name of media set
* (``number``) ``tokens``: how many tokens paid

message
-------
type: ``object``

* (``string``) ``color``:  color of message
* (``string`` or ``null``) ``bgColor``: background color of message
* (``string``) ``message``: message
* (``string``) ``font``: font of message
* (``string``) ``fromUser``: username who sent message (**Private Messages only**)
* (``string``) ``toUser``: username who received message (**Private Messages only**)

subject
-------
type: ``string``

the room title

tip
---
type: ``object``

* (``number``) ``tokens``: number of tokens tipped
* (``bool``) ``isAnon``: did user tip anonymously?
* (``string``) ``message``: tip message

user
----
type: ``object``

* (``string``) ``user``: the user's username
* (``bool``) ``inFanclub``: is the user in the broadcasters fan club
* (``bool``) ``hasTokens``: does the user have at least 1 token
* (``bool``) ``isMod``: is the user a moderator
* (``string``) ``recentTips``: "none" (grey), "some" (dark blue), "lots" (light purple), or "tons" (dark purple)
* (``string``) ``gender``: "m" (male), "f" (female), "t" (trans), or "c" (couple)
* (``string``) ``subgender``: "" (non-trans), "tf" (transfemme), "tm" (transmasc), or "tn" (non-binary)

Be aware that U.S. Patent 9,762,515 pertains to tip-based vibrations for adult toys. Chaturbate's terms of service prohibit any use that infringes any third-party intellectual property.