Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VideoMessage

Represents a VideoMessage.

Hierarchy

  • VideoMessage

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

caption

caption: string

VideoMessage caption.

Optional contextInfo

contextInfo: IContextInfo

VideoMessage contextInfo.

directPath

directPath: string

VideoMessage directPath.

fileEncSha256

fileEncSha256: Uint8Array

VideoMessage fileEncSha256.

fileLength

fileLength: number | Long

VideoMessage fileLength.

fileSha256

fileSha256: Uint8Array

VideoMessage fileSha256.

gifAttribution

gifAttribution: VideoMessageAttribution

VideoMessage gifAttribution.

gifPlayback

gifPlayback: boolean

VideoMessage gifPlayback.

height

height: number

VideoMessage height.

interactiveAnnotations

interactiveAnnotations: IInteractiveAnnotation[]

VideoMessage interactiveAnnotations.

jpegThumbnail

jpegThumbnail: Uint8Array

VideoMessage jpegThumbnail.

mediaKey

mediaKey: Uint8Array

VideoMessage mediaKey.

mediaKeyTimestamp

mediaKeyTimestamp: number | Long

VideoMessage mediaKeyTimestamp.

mimetype

mimetype: string

VideoMessage mimetype.

seconds

seconds: number

VideoMessage seconds.

staticUrl

staticUrl: string

VideoMessage staticUrl.

streamingSidecar

streamingSidecar: Uint8Array

VideoMessage streamingSidecar.

thumbnailDirectPath

thumbnailDirectPath: string

VideoMessage thumbnailDirectPath.

thumbnailEncSha256

thumbnailEncSha256: Uint8Array

VideoMessage thumbnailEncSha256.

thumbnailSha256

thumbnailSha256: Uint8Array

VideoMessage thumbnailSha256.

url

url: string

VideoMessage url.

viewOnce

viewOnce: boolean

VideoMessage viewOnce.

width

width: number

VideoMessage width.

Methods

toJSON

  • toJSON(): {}

Static create

Static decode

  • decode(reader: Uint8Array | Reader, length?: number): VideoMessage

  • Decodes a VideoMessage message from the specified reader or buffer.

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional length: number

    Returns VideoMessage

    VideoMessage

Static decodeDelimited

  • decodeDelimited(reader: Uint8Array | Reader): VideoMessage

  • Decodes a VideoMessage message from the specified reader or buffer, length delimited.

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns VideoMessage

    VideoMessage

Static encode

  • Encodes the specified VideoMessage message. Does not implicitly verify messages.

    Parameters

    • message: IVideoMessage

      VideoMessage message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static encodeDelimited

  • encodeDelimited(message: IVideoMessage, writer?: Writer): Writer

  • Encodes the specified VideoMessage message, length delimited. Does not implicitly verify messages.

    Parameters

    • message: IVideoMessage

      VideoMessage message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static fromObject

  • Creates a VideoMessage message from a plain object. Also converts values to their respective internal types.

    Parameters

    • object: {}

      Plain object

      • [k: string]: any

    Returns VideoMessage

    VideoMessage

Static toObject

  • toObject(message: VideoMessage, options?: IConversionOptions): {}

  • Creates a plain object from a VideoMessage message. Also converts values to other types if specified.

    Parameters

    • message: VideoMessage

      VideoMessage

    • Optional options: IConversionOptions

    Returns {}

    Plain object

    • [k: string]: any

Static verify

  • verify(message: {}): string

  • Verifies a VideoMessage message.

    Parameters

    • message: {}

      Plain object to verify

      • [k: string]: any

    Returns string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc