# Protocol Documentation ## Table of Contents - [proto/Channel.proto](#proto/Channel.proto) - [ChannelMetadata](#.ChannelMetadata) - [proto/Person.proto](#proto/Person.proto) - [PersonMetadata](#.PersonMetadata) - [proto/Playlist.proto](#proto/Playlist.proto) - [PlaylistMetadata](#.PlaylistMetadata) - [proto/Series.proto](#proto/Series.proto) - [SeasonMetadata](#.SeasonMetadata) - [SeriesMetadata](#.SeriesMetadata) - [proto/Video.proto](#proto/Video.proto) - [License](#.License) - [MediaType](#.MediaType) - [PublishedBeforeJoystream](#.PublishedBeforeJoystream) - [VideoMetadata](#.VideoMetadata) - [Scalar Value Types](#scalar-value-types)

## proto/Channel.proto ### ChannelMetadata | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | title | [string](#string) | optional | Channel Title | | description | [string](#string) | optional | Channel Description | | is_public | [bool](#bool) | optional | Wether to display channel to the public | | language | [string](#string) | optional | ISO_639-1 Language [Code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |

## proto/Person.proto ### PersonMetadata | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | first_name | [string](#string) | optional | | | middle_name | [string](#string) | optional | | | last_name | [string](#string) | optional | | | about | [string](#string) | optional | |

Top

## proto/Playlist.proto ### PlaylistMetadata | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | title | [string](#string) | optional | |

Top

## proto/Series.proto ### SeasonMetadata | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | title | [string](#string) | optional | | | description | [string](#string) | optional | | ### SeriesMetadata | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | title | [string](#string) | optional | | | description | [string](#string) | optional | |

Top

## proto/Video.proto ### License License types defined by Joystream | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | code | [int32](#int32) | optional | License code defined by Joystream. [reference](../src/KnownLicenses.json) | | attribution | [string](#string) | optional | Text for licenses that require an attribution | | custom_text | [string](#string) | optional | Text for custom license type | ### MediaType Codec, Container, MIME media-type information | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | codec_name | [string](#string) | optional | Codec corresponding to `name` field from [FFmpeg](https://github.com/FFmpeg/FFmpeg/blob/master/libavcodec/codec_desc.c) | | container | [string](#string) | optional | Video container format, eg. 'MP4', 'WebM', 'Ogg' [ref](https://developer.mozilla.org/en-US/docs/Web/Media/Formats/Video_codecs) | | mime_media_type | [string](#string) | optional | MIME Media Type, eg. 'video/mp4' [ref](https://www.iana.org/assignments/media-types/media-types.xhtml#video) | ### PublishedBeforeJoystream Publication status before joystream | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | is_published | [bool](#bool) | optional | Was video published before joystream platform | | timestamp | [uint32](#uint32) | optional | Unix timestamp in milli-seconds | ### VideoMetadata | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | title | [string](#string) | optional | Video Title | | description | [string](#string) | optional | Video Description | | duration | [int32](#int32) | optional | Lengths of video in seconds | | media_pixel_height | [int32](#int32) | optional | Resolution of the video (Height) | | media_pixel_width | [int32](#int32) | optional | Resolution of the video (Width) | | media_type | [MediaType](#MediaType) | optional | Encoding and Container format used | | language | [string](#string) | optional | ISO_639-1 Language [Code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) | | license | [License](#License) | optional | License type for the media | | published_before_joystream | [PublishedBeforeJoystream](#PublishedBeforeJoystream) | optional | Date of publication | | has_marketing | [bool](#bool) | optional | Does video have marketing or advertising in the stream | | is_public | [bool](#bool) | optional | Should video be publicy visible yet | | is_explicit | [bool](#bool) | optional | Does Video have explicit language or scenes | ## Scalar Value Types | .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | | ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | | double | | double | double | float | float64 | double | float | Float | | float | | float | float | float | float32 | float | float | Float | | int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | | int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | | uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | | uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | | sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | | sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | | fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | | fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | | sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | | sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | | bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | | string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | | bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |