Skip to content

class Tourmaline::InputMediaAudio
inherits Reference #

Represents an audio file to be treated as music to be sent.

Included modules

JSON::Serializable

Constructors#

.new(pull : JSON::PullParser) #

View source

.new(media, type = "audio", thumbnail : ::File | String | Nil = nil, caption : String? = nil, parse_mode : ParseMode = ParseMode::Markdown, caption_entities : Array(Tourmaline::MessageEntity) = [] of Tourmaline::MessageEntity, duration : Int32 | Int64 | Nil = nil, performer : String? = nil, title : String? = nil) #

View source

Methods#

#caption : String? #

Optional. Caption of the audio to be sent, 0-1024 characters after entities parsing

View source

#caption=(caption : String?) #

Optional. Caption of the audio to be sent, 0-1024 characters after entities parsing

View source

#caption_entities : Array(Tourmaline::MessageEntity) #

Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode

View source

#caption_entities=(caption_entities : Array(Tourmaline::MessageEntity)) #

Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode

View source

#duration : Int32 | Int64 | Nil #

Optional. Duration of the audio in seconds

View source

#duration=(duration : Int32 | Int64 | Nil) #

Optional. Duration of the audio in seconds

View source

#media : String #

File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://<file_attach_name>" to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files: https://core.telegram.org/bots/api#sending-files

View source

#media=(media : String) #

File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://<file_attach_name>" to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files: https://core.telegram.org/bots/api#sending-files

View source

#parse_mode : ParseMode #

Optional. Mode for parsing entities in the audio caption. See formatting options for more details.

View source

#parse_mode=(parse_mode : ParseMode) #

Optional. Mode for parsing entities in the audio caption. See formatting options for more details.

View source

#performer : String? #

Optional. Performer of the audio

View source

#performer=(performer : String?) #

Optional. Performer of the audio

View source

#thumbnail : ::File | String | Nil #

Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files: https://core.telegram.org/bots/api#sending-files

View source

#thumbnail=(thumbnail : ::File | String | Nil) #

Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files: https://core.telegram.org/bots/api#sending-files

View source

#title : String? #

Optional. Title of the audio

View source

#title=(title : String?) #

Optional. Title of the audio

View source

#type : String #

Type of the result, must be audio

View source

#type=(type : String) #

Type of the result, must be audio

View source