Default package

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: WorkingGroupMetadataAction

• optional UpcomingOpeningMetadata metadata = 1

  Upcoming opening metadata

• required string app_id = 999

  ID of application

• optional bytes metadata = 2

  Metadata

• optional bytes raw_action = 3

  Raw metadata of wrapped action

• optional bytes signature = 4

  Signature over app commitment

• CREATE_VIDEO = 0

• CREATE_CHANNEL = 1

• CHANNEL = 0

• MEMBER = 1

• CURATOR_GROUP = 2

• optional string video_id = 2

  YouTube video ID

Used in: CreateApp, UpdateApp

• optional string website_url = 2

  Url where user can read more about the project or company for this app

• optional string use_uri = 3

  Url to the app

• optional string small_icon = 4

• optional string medium_icon = 5

• optional string big_icon = 6

• optional string one_liner = 7

  Tagline for the app

• optional string description = 8

• optional string terms_of_service = 9

• optional string auth_key = 10

• repeated string platforms = 11

  List of platforms on which the app will be available, e.g. [mobile, web, native]

• optional string category = 12

  E.g messaging, adult

• repeated string answers = 1

  List of answers to opening application form questions

Used in: ChannelOwnerRemarked

• required uint64 member_id = 1

  ID of the member that channel owner wants to ban from participating on any video.

• required BanOrUnbanMemberFromChannel.Option option = 2

  Selected option to ban or unban member from the channel

Used in: BanOrUnbanMemberFromChannel

• BAN = 0

  Ban member (nothing happens if member is already banned)

• UNBAN = 1

  Unban member (nothing happens if member is already unbanned)

Used in: TokenMetadata

• optional string title = 1

• optional string description = 2

• optional string emoji = 3

• optional uint32 display_order = 4

• optional string title = 1

  Bounty title

• optional string description = 2

  Bounty description

• optional uint64 discussionThread = 3

  Id of the forum thread used to discuss the bounty

• optional string banner_image_uri = 4

  Image uri of the bounty's banner

• optional string title = 1

  Title of the work

• optional string description = 2

  Description which contains the work itself as a URL, a BLOB, or just text

• optional string title = 1

  Channel Title

• optional string description = 2

  Channel Description

• optional bool is_public = 3

  Wether to display channel to the public

• optional string language = 4

  ISO_639-1 Language [Code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)

• optional uint32 cover_photo = 5

  index into external [assets array](#.Assets)

• optional uint32 avatar_photo = 6

  index into external [assets array](#.Assets)

• oneof channel_moderator_remarked

  channel_moderator_remark extrinsic would emit event containing any one of the following serialized messages

  • ModerateComment moderate_comment = 1

• oneof channel_owner_remarked

  channel_owner_remark extrinsic would emit event containing any one of the following serialized messages

  • PinOrUnpinComment pin_or_unpin_comment = 1

  • BanOrUnbanMemberFromChannel ban_or_unban_member_from_channel = 2

  • VideoReactionsPreference video_reactions_preference = 3

  • ModerateComment moderate_comment = 5

• required ChannelPayoutsMetadata.Header header = 1

  Payload header

• required ChannelPayoutsMetadata.Body body = 2

  Payload body

Channel payout full body structure, it will not be downloaded by clients in full

Used in: ChannelPayoutsMetadata

• repeated Body.ChannelPayoutProof channel_payouts = 1

  List of channel payouts

Used in: Body

• required uint32 channel_id = 1

• required string cumulative_reward_earned = 2

  Since protobuf does not support 128 bit unsigned inetgers so string representation is being used here, after message decoding the string would be converted to BN to pervent precision loss

• repeated ChannelPayoutProof.ProofElement merkle_branch = 3

• required string reason = 4

  reward rationale for channel;

Used in: ChannelPayoutProof

• required string hash = 1

• required Side side = 2

Used in: ProofElement

• Left = 0

• Right = 1

* Fields in the payload header are encoded in fixed length 32/64 bits instead of [varint encoding](https://developers.google.com/protocol-buffers/docs/encoding#varints) (uint64/32). This allows first calculating, and then setting the byte offset of each `ChannelPayoutProof` accurately, e.g. `byte_offset` = `size(Header)` + `position_where_record_for_channel_exists_in_Body` If varint encoding is used for header fields, then calculating the byte offset of `ChannelPayoutProof` w.r.t the start of the payload would be improbable since the header size won't be known.

Used in: ChannelPayoutsMetadata

• required fixed64 payload_length_in_bytes = 1

  Length in bytes of entire payload

• required fixed64 header_length_in_bytes = 2

  Length in bytes of payload header

• required fixed32 number_of_channels = 3

  Number of channels

• repeated Header.ChannelPayoutByteOffset channel_payout_byte_offsets = 4

  List of byte offsets for all channels

Used in: Header

• required fixed32 channel_id = 1

  Channel id

• required fixed64 byte_offset = 2

  Byte offset from start of payload where payout record for given channel Id exists

• oneof content_metadata

  • VideoMetadata video_metadata = 1

    ... Other possible metadata standards, e.g. `PlaylistMetadata`

• optional string header = 1

  Candidacy header text

• repeated string bullet_points = 2

  Candidate program in form of bullet points

• optional string banner_image_uri = 3

  Image uri of candidate's banner

• optional string description = 4

  Candidacy description (md-formatted)

Used in: MemberRemarked

• required string name = 1

• optional AppMetadata app_metadata = 2

create comment

Used in: MemberRemarked

• required uint64 video_id = 1

  ID of the video

• optional string parent_comment_id = 2

  ID of comment member wants to reply (empty if new comment is parent comment)

• required string body = 3

  Comment text

Used in: MemberRemarked

• required string name = 1

• optional string description = 2

• optional string parent_category_id = 3

• oneof creator_token_issuer_remarked

  • UpdateTokenMetadata update_token_metadata = 1

delete comment by author

Used in: MemberRemarked

• required string comment_id = 1

  ID of the comment which will be deleted

• optional string region = 1

  ID / name of the region covered by the distribution family (ie. us-east-1). Should be unique.

• optional string description = 2

  Additional, more specific description of the region

• repeated GeographicalArea areas = 3

  Standarized geographical areas covered by the family (providing [{}] will unset the current value)

• repeated string latency_test_targets = 4

  List of targets (hosts/ips) best suited latency measurements for this family

• optional string endpoint = 1

  Root distribution node endpoint (ie. https://example.com/distribution)

• optional NodeLocationMetadata location = 2

  Information about node's phisical location (providing {} will unset current value)

• optional string extra = 3

  Additional information about the node / node operator

edit comment by author

Used in: MemberRemarked

• required string comment_id = 1

  ID of the comment whose text is being edited

• required string new_body = 2

  New comment body

• optional string text = 1

  Post text content (md-formatted)

• optional uint32 repliesTo = 2

  Id of the post that given post replies to (if any)

• optional string title = 1

  Thread title

• repeated string tags = 2

  * Tags accociated with the thread. Any update overrides all current tags. Only the first {MAX_TAGS_PER_FORUM_THREAD} (const exposed via @joystream/metadata-protobuf/consts) tags are taken into account. In order to unset current tags, [''] (array with empty string) must be provided as value.

Used in: NodeLocationMetadata

• optional float latitude = 3

• optional float longitude = 4

Used in: DistributionBucketFamilyMetadata

• oneof code

  • GeographicalArea.Continent continent = 1

  • string country_code = 2

    ISO 3166-1 alpha-2 country code

  • string subdivision_code = 3

    ISO 3166-2 subdivision code

Used in: GeographicalArea

• AF = 1

• NA = 2

• OC = 3

• AN = 4

• AS = 5

• EU = 6

• SA = 7

License types defined by Joystream

Used in: VideoMetadata

• optional uint32 code = 1

  License code defined by Joystream. [reference](../src/KnownLicenses.json)

• optional string attribution = 2

  Text for licenses that require an attribution

• optional string custom_text = 3

  Text for custom license type

Used in: MemberRemarked

• optional string rationale = 1

  Reason why payment is being made

• oneof payment_context

  Context of payment, if it is being made for channel or specific video. default is assumed to be `channel` if no conext provided

  • uint64 video_id = 2

    Other possible contexts, e.g. playlist etc.

Codec, Container, MIME media-type information

Used in: VideoMetadata

• optional string codec_name = 1

  Codec corresponding to `name` field from [FFmpeg](https://github.com/FFmpeg/FFmpeg/blob/master/libavcodec/codec_desc.c)

• optional string container = 2

  Video container format, eg. 'MP4', 'WebM', 'Ogg' [ref](https://developer.mozilla.org/en-US/docs/Web/Media/Formats/Video_codecs)

• optional string mime_media_type = 3

  MIME Media Type, eg. 'video/mp4' [ref](https://www.iana.org/assignments/media-types/media-types.xhtml#video)

• oneof member_remarked

  member_remark extrinsic would emit event containing any one of the following serialized messages

  • ReactVideo react_video = 1

  • ReactComment react_comment = 2

  • CreateComment create_comment = 3

  • EditComment edit_comment = 4

  • DeleteComment delete_comment = 5

  • CreateVideoCategory create_video_category = 6

  • CreateApp create_app = 7

  • UpdateApp update_app = 8

  • MakeChannelPayment make_channel_payment = 10

    DeleteApp delete_app = 9;

• optional string name = 1

  Member's real name

• oneof avatar

  • uint32 avatar_object = 2

    Member's avatar - index into external [assets array](#.Assets)

  • string avatar_uri = 4

    Url to member's avatar

• optional string about = 3

  Member's md-formatted about text

• repeated MembershipMetadata.ExternalResource externalResources = 5

Used in: MembershipMetadata

• optional ExternalResource.ResourceType type = 1

• optional string value = 2

Used in: ExternalResource

• EMAIL = 0

• HYPERLINK = 1

• TWITTER = 2

• TELEGRAM = 3

• DISCORD = 4

• FACEBOOK = 5

• YOUTUBE = 6

• MATRIX = 7

• IRC = 8

• WECHAT = 9

• WHATSAPP = 10

• LINKEDIN = 11

• GITHUB = 12

delete comment by moderator or channel owner;

Used in: ChannelModeratorRemarked, ChannelOwnerRemarked

• required string comment_id = 1

  ID of comment that will be deleted by moderator

• required string rationale = 2

  why moderator wants to delete this comment

Used in: RemarkMetadataAction

• required uint64 post_id = 1

• required string rationale = 2

Used in: DistributionBucketOperatorMetadata, StorageBucketOperatorMetadata

• optional string country_code = 1

  ISO 3166-1 alpha-2 country code (2 letters)

• optional string city = 2

  City name

• optional GeoCoordiantes coordinates = 3

  Geographic coordinates (providing {} will unset current value)

Used in: UpcomingOpeningMetadata

• optional string short_description = 1

  Short description of the opening

• optional string description = 2

  Full description of the opening

• optional uint32 hiring_limit = 3

  Expected number of hired applicants

• optional uint32 expected_ending_timestamp = 4

  Expected time when the opening will close (Unix timestamp)

• optional string application_details = 5

  Md-formatted text explaining the application process

• repeated OpeningMetadata.ApplicationFormQuestion application_form_questions = 6

  List of questions that should be answered during application

• optional string title = 7

Used in: OpeningMetadata

• optional string question = 1

  The question itself (ie. "What is your name?"")

• optional ApplicationFormQuestion.InputType type = 2

  Suggested type of the UI answer input

Used in: ApplicationFormQuestion

• TEXTAREA = 0

• TEXT = 1

• optional string first_name = 1

• optional string middle_name = 2

• optional string last_name = 3

• optional string about = 4

• optional uint32 cover_photo = 5

  index into external [assets array](#.Assets)

• optional uint32 avatar_photo = 6

  index into external [assets array](#.Assets)

pin comment on a video by channel owner

Used in: ChannelOwnerRemarked

• required uint64 video_id = 1

  ID of the video

• required string comment_id = 2

  ID of the comment which will be pinned

• required PinOrUnpinComment.Option option = 3

  Selected option to pin or unpin comment from channel

Used in: PinOrUnpinComment

• PIN = 0

  Pin comment on video (nothing happens if comment is already pinned)

• UNPIN = 1

  Unpin comment from video (nothing happens if comment is already unpinned)

• optional string text = 1

  Post text content (md-formatted)

• optional uint32 repliesTo = 2

  Id of the post that given post replies to (if any)

Publication status before joystream

Used in: VideoMetadata

• optional bool is_published = 1

  Was video published before joystream platform

• optional string date = 2

  Date of publication: 'YYYY-MM-DD' [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html)

reacting, unreacting to a comment

Used in: MemberRemarked

• required string comment_id = 1

  ID of the comment to react

• required uint32 reaction_id = 2

  ID of the selected reaction

reacting, unreacting, and changing reaction to video

Used in: MemberRemarked

• required uint64 video_id = 1

  ID of the video to react

• required ReactVideo.Reaction reaction = 2

  Selected reaction

The enum must be wrapped inside "message", otherwide it breaks protobufjs Reacting again with the same message option will cancel the previous reaction

Used in: ReactVideo

• LIKE = 0

• UNLIKE = 1

• oneof action

  • ModeratePost moderate_post = 1

  • VerifyValidator verify_validator = 2

Used in: WorkingGroupMetadataAction

• optional string id = 1

  Upcoming opening query-node id

• optional string terms_and_conditions = 1

• optional string title = 1

• optional string description = 2

• optional uint32 cover_photo = 3

  index into external [assets array](#.Assets)

• repeated uint64 persons = 4

  Person(s) referenced by PersonId involved in this Season

• optional string title = 1

• optional string description = 2

• optional uint32 cover_photo = 3

  index into external [assets array](#.Assets)

• repeated uint64 persons = 4

  Person(s) referenced by PersonId involved in this Series

Used in: WorkingGroupMetadataAction

• optional WorkingGroupMetadata new_metadata = 1

  New working group metadata to set (can be a partial update)

• optional string endpoint = 1

  Root storage node endpoint (ie. https://example.com/storage)

• optional NodeLocationMetadata location = 2

  Information about node's phisical location (providing {} will unset current value)

• optional string extra = 3

  Additional information about the node / node operator

Used in: VideoMetadata

• required string type = 1

• optional uint32 new_asset = 2

  index into external [assets array](#.Assets)

• required string language = 3

  ISO_639-1 Language [Code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)

• required string mimeType = 4

Used in: UpdateTokenMetadata

• optional string name = 1

  Title

• optional string symbol = 2

  Symbol

• optional string description = 3

  token description

• oneof avatar

  • uint32 avatar_object = 4

    avatar for token - index into external [assets array](#.Assets)

  • string avatar_uri = 5

    Url to member's avatar

• repeated Benefit benefits = 6

  benefits for tokne

• optional string whitelist_application_note = 7

  note for applicant

• optional string whitelist_application_apply_link = 8

  link to application process

• optional uint64 trailer_video_id = 9

  runtime id for video trailer

Used in: AddUpcomingOpening

• optional uint32 expected_start = 1

  Expected opening start (timestamp)

• optional uint64 reward_per_block = 2

  Expected reward per block

• optional uint64 min_application_stake = 3

  Expected min. application stake

• optional OpeningMetadata metadata = 4

  Opening metadata

Used in: MemberRemarked

• required string app_id = 1

• optional AppMetadata app_metadata = 2

Used in: CreatorTokenIssuerRemarked

• optional TokenMetadata new_metadata = 1

Used in: RemarkMetadataAction

• required uint64 member_id = 1

• required bool is_verified = 2

Used in: ContentMetadata

• optional string title = 1

  Video Title

• optional string description = 2

  Video Description

• optional uint32 video = 3

  index into external [assets array](#.Assets)

• optional uint32 thumbnail_photo = 4

  index into external [assets array](#.Assets)

• optional uint32 duration = 5

  Lengths of video in seconds

• optional uint32 media_pixel_height = 6

  Resolution of the video (Height)

• optional uint32 media_pixel_width = 7

  Resolution of the video (Width)

• optional MediaType media_type = 8

  Encoding and Container format used

• optional string language = 9

  ISO_639-1 Language [Code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)

• optional License license = 10

  License type for the media

• optional PublishedBeforeJoystream published_before_joystream = 11

  Date of publication

• optional bool has_marketing = 12

  Does video have marketing or advertising in the stream

• optional bool is_public = 13

  Should video be publicy visible yet

• optional bool is_explicit = 14

  Does Video have explicit language or scenes

• repeated uint64 persons = 15

  Person(s) referenced by PersonId involved in this video

• optional string category = 16

  Video Category Id

• repeated SubtitleMetadata subtitles = 17

  Video subtitles

• optional bool enable_comments = 18

  Enable/Disable the comment section

• optional bool clear_subtitles = 19

  Remove all subtitles; since protobuf doesn't distinguish b/w empty array and null field, simply removing all subtitles by overriding list with an empty array wont work

• optional bool is_short = 20

  Is video a short format, vertical video (e.g. Youtube Shorts, TikTok, Instagram Reels)

Enable or disable reactions on a single video

Used in: ChannelOwnerRemarked

• required uint64 video_id = 1

  ID of the video

• required VideoReactionsPreference.Option option = 2

  Selected option to enable or disable comment section

Used in: VideoReactionsPreference

• ENABLE = 0

  Enable reactions (nothing happens if they are already enabled)

• DISABLE = 1

  Disable reactions (nothing happens if they are already disabled)

Used in: SetGroupMetadata

• optional string description = 1

  Group description text (md-formatted)

• optional string about = 2

  Group about text (md-formatted)

• optional string status = 3

  Current group status (expected to be 1-3 words)

• optional string status_message = 4

  Short status message associated with the status

• oneof action

  • SetGroupMetadata set_group_metadata = 1

  • AddUpcomingOpening add_upcoming_opening = 2

  • RemoveUpcomingOpening remove_upcoming_opening = 3