# Pixellot WebSDK - v3.1.1
# Table of contents
# Namespaces
# Classes
# Other Interfaces
- AdSource
- CastButtons
- Component
- GameInfo
- ID3Event
- ID3ExtentData
- PixellotPlayer
- PixellotPlayerConfig
- PixellotPlayerConfigUpdate
- PixellotPlayerCore
- PixellotPlayerOptions
- PlayerAnalyticsOptions
- PlayerBrushConfig
- PlayerCanvas
- PlayerMetadata
- PlayerNextSource
- PlayerPano
- PlayerPanoBase
- PlayerPanoConfig
- PlayerRecorderConfig
- PlayerSharingMetadata
- PlayerSource
- PlayerTagsUI
- PlayerUI
- THEOCorePlayer
- Tag
- TagsConfig
- ThumbnailsSprite
- TimeRange
- TimeRangeComponent
- upcomingLiveOverlayComponent
# Player Interfaces
# Type aliases
- PanoMode
- PixellotPlayerConfigHD
- PixellotPlayerConfigPano
- PlayerMode
- PlayerSrc
- PlayerThumbnailsSrc
- RecordingState
- TagType
- TagTypesBaseball
- TagTypesBasketball
- TagTypesBeach
- TagTypesField
- TagTypesFootball
- TagTypesFutsal
- TagTypesGeneral
- TagTypesGymnastic
- TagTypesHandball
- TagTypesHockey
- TagTypesLacrosse
- TagTypesOther
- TagTypesRoller
- TagTypesRollerHockey
- TagTypesRugby
- TagTypesSnooker
- TagTypesSoccer
- TagTypesVolleyball
- TagTypesWrestling
# Variables
# Type aliases
# PanoMode
Ƭ PanoMode: "full" | "restricted"
# PixellotPlayerConfigHD
Ƭ PixellotPlayerConfigHD: PlayerPanoConfig & { brush: boolean | PlayerBrushConfig ; recorder: boolean | PlayerRecorderConfig }
# PixellotPlayerConfigPano
Ƭ PixellotPlayerConfigPano: PlayerPanoConfig & { brush: boolean | PlayerBrushConfig ; recorder: boolean | PlayerRecorderConfig }
# PlayerMode
Ƭ PlayerMode: "hd" | "pano"
# PlayerSrc
Ƭ PlayerSrc: string | { src: string ; type: string }
# PlayerThumbnailsSrc
Ƭ PlayerThumbnailsSrc: string | ThumbnailsSprite | ThumbnailsSprite[]
# RecordingState
Ƭ RecordingState: "inactive" | "recording" | "paused"
# TagType
Ƭ TagType: TagTypesGeneral | TagTypesBaseball | TagTypesBasketball | TagTypesBeach | TagTypesField | TagTypesFootball | TagTypesFutsal | TagTypesGymnastic | TagTypesHandball | TagTypesHockey | TagTypesLacrosse | TagTypesRoller | TagTypesRollerHockey | TagTypesRugby | TagTypesSnooker | TagTypesSoccer | TagTypesVolleyball | TagTypesWrestling | TagTypesOther
List of allowed tag types.
# TagTypesBaseball
Ƭ TagTypesBaseball: "baseball_bottom_1st" | "baseball_bottom_2nd" | "baseball_double" | "baseball_double_play" | "baseball_fly_out" | "baseball_ground_out" | "baseball_hit" | "baseball_home_run" | "baseball_popout" | "baseball_run" | "baseball_single" | "baseball_stolen_base" | "baseball_strikeout" | "baseball_substitution" | "baseball_top_1st" | "baseball_top_2nd" | "baseball_triple_play" | "baseball_tripple" | "baseball_walk"
# TagTypesBasketball
Ƭ TagTypesBasketball: "basketball_alley_oop" | "basketball_assist" | "basketball_big_play" | "basketball_block" | "basketball_dunk" | "basketball_momentym" | "basketball_money_time" | "basketball_substitution" | "basketball_three_point"
# TagTypesBeach
Ƭ TagTypesBeach: "beach_volleyball_dig" | "beach_volleyball_double" | "beach_volleyball_free_ball" | "beach_volleyball_match_point" | "beach_volleyball_mishit" | "beach_volleyball_serve" | "beach_volleyball_set_point" | "beach_volleyball_shank" | "beach_volleyball_side_out" | "beach_volleyball_spike" | "beach_volleyball_substitution"
# TagTypesField
Ƭ TagTypesField: "field_ball_loss" | "field_ball_possesion" | "field_circle_penetration" | "field_hockey_4v4" | "field_hockey_big_hit" | "field_hockey_fight" | "field_hockey_goal" | "field_hockey_other" | "field_hockey_power_play" | "field_hockey_save" | "field_hockey_shot" | "field_hockey_substitution" | "field_interception" | "field_penalty_corner" | "field_press_fp_hc" | "field_time_penalty" | "field_turn_over"
# TagTypesFootball
Ƭ TagTypesFootball: "football_big_catch" | "football_big_hit" | "football_big_run" | "football_field_goal" | "football_kick_return" | "football_kickoff" | "football_punt_return" | "football_substitution" | "football_touch_down"
# TagTypesFutsal
Ƭ TagTypesFutsal: "futsal_corner_kick" | "futsal_foul" | "futsal_free_kick" | "futsal_goal" | "futsal_header" | "futsal_penalty" | "futsal_redcard" | "futsal_save" | "futsal_shot" | "futsal_shot_on_target" | "futsal_substitution" | "futsal_yellowcard"
# TagTypesGeneral
Ƭ TagTypesGeneral: "general_bad" | "general_drill" | "general_end" | "general_good" | "general_mark" | "general_start"
# TagTypesGymnastic
Ƭ TagTypesGymnastic: "gymnastic_wow"
# TagTypesHandball
Ƭ TagTypesHandball: "handball_foul" | "handball_goal" | "handball_penalty_shot" | "handball_red_card" | "handball_save" | "handball_shot_on_goal" | "handball_substitution" | "handball_suspension" | "handball_yellow_card"
# TagTypesHockey
Ƭ TagTypesHockey: "hockey_4v4" | "hockey_big_hit" | "hockey_fight" | "hockey_goal" | "hockey_power_play" | "hockey_save" | "hockey_shot" | "hockey_substitution"
# TagTypesLacrosse
Ƭ TagTypesLacrosse: "lacrosse_clear" | "lacrosse_face_off" | "lacrosse_goal" | "lacrosse_ground_ball" | "lacrosse_man_up" | "lacrosse_penalty" | "lacrosse_save" | "lacrosse_shot" | "lacrosse_substitution"
# TagTypesOther
Ƭ TagTypesOther: "other_wow"
# TagTypesRoller
Ƭ TagTypesRoller: "roller_ball_loss" | "roller_ball_possession" | "roller_circle_penetration" | "roller_hockey_4v4" | "roller_hockey_big_hit" | "roller_hockey_fight" | "roller_hockey_goal" | "roller_hockey_other" | "roller_hockey_power_play" | "roller_hockey_save" | "roller_hockey_shot" | "roller_interception" | "roller_penalty_corner" | "roller_press_fp_hc" | "roller_time_penalty" | "roller_turn_over"
# TagTypesRollerHockey
Ƭ TagTypesRollerHockey: "roller_hockey_4v4" | "roller_hockey_big_hit" | "roller_hockey_fight" | "roller_hockey_goal" | "roller_hockey_power_play" | "roller_hockey_save" | "roller_hockey_shot" | "roller_hockey_substitution"
# TagTypesRugby
Ƭ TagTypesRugby: "rugby_break_down" | "rugby_conversion" | "rugby_drop_goal" | "rugby_garry_owen" | "rugby_grubber" | "rugby_knock_on" | "rugby_maul" | "rugby_penalty_try" | "rugby_substitution"
# TagTypesSnooker
Ƭ TagTypesSnooker: "snooker_foul" | "snooker_snooker" | "snooker_wow"
# TagTypesSoccer
Ƭ TagTypesSoccer: "soccer_corner_kick" | "soccer_foul" | "soccer_free_kick" | "soccer_goal" | "soccer_header" | "soccer_penalty" | "soccer_redcard" | "soccer_save" | "soccer_shot" | "soccer_shot_on_target" | "soccer_substitution" | "soccer_yellowcard"
# TagTypesVolleyball
Ƭ TagTypesVolleyball: "volleyball_dig" | "volleyball_double" | "volleyball_free_ball" | "volleyball_match_point" | "volleyball_mishit" | "volleyball_serve" | "volleyball_set_point" | "volleyball_shank" | "volleyball_side_out" | "volleyball_spike" | "volleyball_substitution"
# TagTypesWrestling
Ƭ TagTypesWrestling: "wrestling_wow"
# Variables
# logger
• Const logger: Object
General SDK logger.
# Type declaration
| Name | Type |
|---|---|
enabled | boolean |
history | never[] |
title | string |
error | (message: string | Error, meta: any) => void |
info | (message: string, meta: any) => void |
log | (message: string, meta: any) => void |
warn | (message: string, meta: any) => void |
# players
• Const players: never[] = []
Holds players created with PixellotWebSDK.Player class.
# updatedAt
• Const updatedAt: string = __APP_BUILD_DATE__
Date of latest update of used Pixellot WebSDK (UTC time).
# version
• Const version: string = __APP_VERSION__
Current version of used Pixellot WebSDK.