BaseItemDto
This is strictly used as a data transfer object from the api layer. This holds information about a BaseItem in a format that is convenient for the client.
Properties
Name | Type | Description | Notes |
---|---|---|---|
name | str | Gets or sets the name. | [optional] |
original_title | str | [optional] | |
server_id | str | Gets or sets the server identifier. | [optional] |
id | str | Gets or sets the id. | [optional] |
etag | str | Gets or sets the etag. | [optional] |
source_type | str | Gets or sets the type of the source. | [optional] |
playlist_item_id | str | Gets or sets the playlist item identifier. | [optional] |
date_created | datetime | Gets or sets the date created. | [optional] |
date_last_media_added | datetime | [optional] | |
extra_type | ExtraType | [optional] | |
airs_before_season_number | int | [optional] | |
airs_after_season_number | int | [optional] | |
airs_before_episode_number | int | [optional] | |
can_delete | bool | [optional] | |
can_download | bool | [optional] | |
has_lyrics | bool | [optional] | |
has_subtitles | bool | [optional] | |
preferred_metadata_language | str | [optional] | |
preferred_metadata_country_code | str | [optional] | |
container | str | [optional] | |
sort_name | str | Gets or sets the name of the sort. | [optional] |
forced_sort_name | str | [optional] | |
video3_d_format | Video3DFormat | Gets or sets the video3 D format. | [optional] |
premiere_date | datetime | Gets or sets the premiere date. | [optional] |
external_urls | List[ExternalUrl] | Gets or sets the external urls. | [optional] |
media_sources | List[MediaSourceInfo] | Gets or sets the media versions. | [optional] |
critic_rating | float | Gets or sets the critic rating. | [optional] |
production_locations | List[str] | [optional] | |
path | str | Gets or sets the path. | [optional] |
enable_media_source_display | bool | [optional] | |
official_rating | str | Gets or sets the official rating. | [optional] |
custom_rating | str | Gets or sets the custom rating. | [optional] |
channel_id | str | Gets or sets the channel identifier. | [optional] |
channel_name | str | [optional] | |
overview | str | Gets or sets the overview. | [optional] |
taglines | List[str] | Gets or sets the taglines. | [optional] |
genres | List[str] | Gets or sets the genres. | [optional] |
community_rating | float | Gets or sets the community rating. | [optional] |
cumulative_run_time_ticks | int | Gets or sets the cumulative run time ticks. | [optional] |
run_time_ticks | int | Gets or sets the run time ticks. | [optional] |
play_access | PlayAccess | Gets or sets the play access. | [optional] |
aspect_ratio | str | Gets or sets the aspect ratio. | [optional] |
production_year | int | Gets or sets the production year. | [optional] |
is_place_holder | bool | Gets or sets a value indicating whether this instance is place holder. | [optional] |
number | str | Gets or sets the number. | [optional] |
channel_number | str | [optional] | |
index_number | int | Gets or sets the index number. | [optional] |
index_number_end | int | Gets or sets the index number end. | [optional] |
parent_index_number | int | Gets or sets the parent index number. | [optional] |
remote_trailers | List[MediaUrl] | Gets or sets the trailer urls. | [optional] |
provider_ids | Dict[str, Optional[str]] | Gets or sets the provider ids. | [optional] |
is_hd | bool | Gets or sets a value indicating whether this instance is HD. | [optional] |
is_folder | bool | Gets or sets a value indicating whether this instance is folder. | [optional] |
parent_id | str | Gets or sets the parent id. | [optional] |
type | BaseItemKind | The base item kind. | [optional] |
people | List[BaseItemPerson] | Gets or sets the people. | [optional] |
studios | List[NameGuidPair] | Gets or sets the studios. | [optional] |
genre_items | List[NameGuidPair] | [optional] | |
parent_logo_item_id | str | Gets or sets whether the item has a logo, this will hold the Id of the Parent that has one. | [optional] |
parent_backdrop_item_id | str | Gets or sets whether the item has any backdrops, this will hold the Id of the Parent that has one. | [optional] |
parent_backdrop_image_tags | List[str] | Gets or sets the parent backdrop image tags. | [optional] |
local_trailer_count | int | Gets or sets the local trailer count. | [optional] |
user_data | UserItemDataDto | Gets or sets the user data for this item based on the user it's being requested for. | [optional] |
recursive_item_count | int | Gets or sets the recursive item count. | [optional] |
child_count | int | Gets or sets the child count. | [optional] |
series_name | str | Gets or sets the name of the series. | [optional] |
series_id | str | Gets or sets the series id. | [optional] |
season_id | str | Gets or sets the season identifier. | [optional] |
special_feature_count | int | Gets or sets the special feature count. | [optional] |
display_preferences_id | str | Gets or sets the display preferences id. | [optional] |
status | str | Gets or sets the status. | [optional] |
air_time | str | Gets or sets the air time. | [optional] |
air_days | List[DayOfWeek] | Gets or sets the air days. | [optional] |
tags | List[str] | Gets or sets the tags. | [optional] |
primary_image_aspect_ratio | float | Gets or sets the primary image aspect ratio, after image enhancements. | [optional] |
artists | List[str] | Gets or sets the artists. | [optional] |
artist_items | List[NameGuidPair] | Gets or sets the artist items. | [optional] |
album | str | Gets or sets the album. | [optional] |
collection_type | CollectionType | Gets or sets the type of the collection. | [optional] |
display_order | str | Gets or sets the display order. | [optional] |
album_id | str | Gets or sets the album id. | [optional] |
album_primary_image_tag | str | Gets or sets the album image tag. | [optional] |
series_primary_image_tag | str | Gets or sets the series primary image tag. | [optional] |
album_artist | str | Gets or sets the album artist. | [optional] |
album_artists | List[NameGuidPair] | Gets or sets the album artists. | [optional] |
season_name | str | Gets or sets the name of the season. | [optional] |
media_streams | List[MediaStream] | Gets or sets the media streams. | [optional] |
video_type | VideoType | Gets or sets the type of the video. | [optional] |
part_count | int | Gets or sets the part count. | [optional] |
media_source_count | int | [optional] | |
image_tags | Dict[str, str] | Gets or sets the image tags. | [optional] |
backdrop_image_tags | List[str] | Gets or sets the backdrop image tags. | [optional] |
screenshot_image_tags | List[str] | Gets or sets the screenshot image tags. | [optional] |
parent_logo_image_tag | str | Gets or sets the parent logo image tag. | [optional] |
parent_art_item_id | str | Gets or sets whether the item has fan art, this will hold the Id of the Parent that has one. | [optional] |
parent_art_image_tag | str | Gets or sets the parent art image tag. | [optional] |
series_thumb_image_tag | str | Gets or sets the series thumb image tag. | [optional] |
image_blur_hashes | BaseItemDtoImageBlurHashes | [optional] | |
series_studio | str | Gets or sets the series studio. | [optional] |
parent_thumb_item_id | str | Gets or sets the parent thumb item id. | [optional] |
parent_thumb_image_tag | str | Gets or sets the parent thumb image tag. | [optional] |
parent_primary_image_item_id | str | Gets or sets the parent primary image item identifier. | [optional] |
parent_primary_image_tag | str | Gets or sets the parent primary image tag. | [optional] |
chapters | List[ChapterInfo] | Gets or sets the chapters. | [optional] |
trickplay | Dict[str, Dict[str, TrickplayInfoDto]] | Gets or sets the trickplay manifest. | [optional] |
location_type | LocationType | Gets or sets the type of the location. | [optional] |
iso_type | IsoType | Gets or sets the type of the iso. | [optional] |
media_type | MediaType | Media types. | [optional] [default to MediaType.UNKNOWN] |
end_date | datetime | Gets or sets the end date. | [optional] |
locked_fields | List[MetadataField] | Gets or sets the locked fields. | [optional] |
trailer_count | int | Gets or sets the trailer count. | [optional] |
movie_count | int | Gets or sets the movie count. | [optional] |
series_count | int | Gets or sets the series count. | [optional] |
program_count | int | [optional] | |
episode_count | int | Gets or sets the episode count. | [optional] |
song_count | int | Gets or sets the song count. | [optional] |
album_count | int | Gets or sets the album count. | [optional] |
artist_count | int | [optional] | |
music_video_count | int | Gets or sets the music video count. | [optional] |
lock_data | bool | Gets or sets a value indicating whether [enable internet providers]. | [optional] |
width | int | [optional] | |
height | int | [optional] | |
camera_make | str | [optional] | |
camera_model | str | [optional] | |
software | str | [optional] | |
exposure_time | float | [optional] | |
focal_length | float | [optional] | |
image_orientation | ImageOrientation | [optional] | |
aperture | float | [optional] | |
shutter_speed | float | [optional] | |
latitude | float | [optional] | |
longitude | float | [optional] | |
altitude | float | [optional] | |
iso_speed_rating | int | [optional] | |
series_timer_id | str | Gets or sets the series timer identifier. | [optional] |
program_id | str | Gets or sets the program identifier. | [optional] |
channel_primary_image_tag | str | Gets or sets the channel primary image tag. | [optional] |
start_date | datetime | Gets or sets the start date of the recording, in UTC. | [optional] |
completion_percentage | float | Gets or sets the completion percentage. | [optional] |
is_repeat | bool | Gets or sets a value indicating whether this instance is repeat. | [optional] |
episode_title | str | Gets or sets the episode title. | [optional] |
channel_type | ChannelType | Gets or sets the type of the channel. | [optional] |
audio | ProgramAudio | Gets or sets the audio. | [optional] |
is_movie | bool | Gets or sets a value indicating whether this instance is movie. | [optional] |
is_sports | bool | Gets or sets a value indicating whether this instance is sports. | [optional] |
is_series | bool | Gets or sets a value indicating whether this instance is series. | [optional] |
is_live | bool | Gets or sets a value indicating whether this instance is live. | [optional] |
is_news | bool | Gets or sets a value indicating whether this instance is news. | [optional] |
is_kids | bool | Gets or sets a value indicating whether this instance is kids. | [optional] |
is_premiere | bool | Gets or sets a value indicating whether this instance is premiere. | [optional] |
timer_id | str | Gets or sets the timer identifier. | [optional] |
normalization_gain | float | Gets or sets the gain required for audio normalization. | [optional] |
current_program | BaseItemDto | Gets or sets the current program. | [optional] |
Example
from jellyfin.generated.api_10_11.models.base_item_dto import BaseItemDto
# TODO update the JSON string below
json = "{}"
# create an instance of BaseItemDto from a JSON string
base_item_dto_instance = BaseItemDto.from_json(json)
# print the JSON string representation of the object
print(BaseItemDto.to_json())
# convert the object into a dict
base_item_dto_dict = base_item_dto_instance.to_dict()
# create an instance of BaseItemDto from a dict
base_item_dto_from_dict = BaseItemDto.from_dict(base_item_dto_dict)