Class: OpenHAB::Core::Items::PlayerItem

Inherits:
GenericItem show all
Defined in:
lib/openhab/core/items/player_item.rb

Overview

A PlayerItem allows control of a player, e.g. an audio player.

Examples:

Start playing on a player item

Chromecast.play

Check if a player is paused

logger.warn("#{item.name} is paused") if Chromecast.paused?

Constant Summary

Constants included from Semantics

Semantics::Equipment, Semantics::Location, Semantics::Point, Semantics::Property, Semantics::Tag

Constants included from Persistence

OpenHAB::Core::Items::Persistence::HistoricState

Instance Attribute Summary collapse

Attributes inherited from GenericItem

#category, #label, #name, #raw_state, #tags

Attributes included from Item

#accepted_command_types, #accepted_data_types, #all_groups, #channel, #channel_uid, #channel_uids, #channels, #command_description, #formatted_state, #groups, #last_state, #last_state_change, #last_state_update, #links, #metadata, #name, #provider, #state_description, #thing, #things

Attributes included from Semantics

#equipment, #equipment_type, #location, #location_type, #point_type, #property_type, #semantic_type

Instance Method Summary collapse

Methods inherited from GenericItem

#modify, #null?, #state?, #time_series=, #undef?, #was?, #was_null?, #was_undef?

Methods included from Item

#call_item?, #color_item?, #command, #contact_item?, #date_time_item?, #dimmer_item?, #group_item?, #image_item?, #inspect, #link, #location_item?, #member_of?, #number_item?, #player_item?, #refresh, #rollershutter_item?, #string_item?, #switch_item?, #tagged?, #to_s, #unlink, #update

Methods included from Semantics

add, #equipment?, #location?, lookup, #point?, #points, remove, #semantic?, tags

Methods included from DSL::Items::Ensure::Ensurable

#ensure

Methods included from Persistence

#all_states_between, #all_states_since, #all_states_until, #average_between, #average_since, #average_until, #changed_between?, #changed_since?, #changed_until?, #count_between, #count_since, #count_state_changes_between, #count_state_changes_since, #count_state_changes_until, #count_until, #delta_between, #delta_since, #delta_until, #deviation_between, #deviation_since, #deviation_until, #evolution_rate, #evolution_rate_between, #evolution_rate_since, #evolution_rate_until, #historic_state, #last_change, #last_update, #maximum_between, #maximum_since, #maximum_until, #median_between, #median_since, #median_until, #minimum_between, #minimum_since, #minimum_until, #next_change, #next_state, #next_update, #persist, #persisted_state, #previous_state, #remove_all_states_between, #remove_all_states_since, #remove_all_states_until, #riemann_sum_between, #riemann_sum_since, #riemann_sum_until, #sum_between, #sum_since, #sum_until, #updated_between?, #updated_since?, #updated_until?, #variance_between, #variance_since, #variance_until

Methods included from DSL::Items::TimedCommand

#command

Instance Attribute Details

#statePlayPauseType, ... (readonly)



98
99
# File 'lib/openhab/core/items/player_item.rb', line 98

class PlayerItem < GenericItem
end

#wasPlayPauseType, ... (readonly)

Returns:

Since:

  • openHAB 5.0



98
99
# File 'lib/openhab/core/items/player_item.rb', line 98

class PlayerItem < GenericItem
end

Instance Method Details

#fast_forwardPlayerItem

Send the FASTFORWARD command to the item

Returns:



98
99
# File 'lib/openhab/core/items/player_item.rb', line 98

class PlayerItem < GenericItem
end

#fast_forward!PlayerItem

Send the FASTFORWARD command to the item, even when ensure_states! is in effect.

Returns:



98
99
# File 'lib/openhab/core/items/player_item.rb', line 98

class PlayerItem < GenericItem
end

#fast_forwarding?true, false

Check if the item state == FASTFORWARD

Returns:

  • (true, false)


98
99
# File 'lib/openhab/core/items/player_item.rb', line 98

class PlayerItem < GenericItem
end

#nextPlayerItem

Send the NEXT command to the item

Returns:



98
99
# File 'lib/openhab/core/items/player_item.rb', line 98

class PlayerItem < GenericItem
end

#pausePlayerItem

Send the PAUSE command to the item

Returns:



98
99
# File 'lib/openhab/core/items/player_item.rb', line 98

class PlayerItem < GenericItem
end

#pause!PlayerItem

Send the PAUSE command to the item, even when ensure_states! is in effect.

Returns:



98
99
# File 'lib/openhab/core/items/player_item.rb', line 98

class PlayerItem < GenericItem
end

#paused?true, false

Check if the item state == PAUSE

Returns:

  • (true, false)


98
99
# File 'lib/openhab/core/items/player_item.rb', line 98

class PlayerItem < GenericItem
end

#playPlayerItem

Send the PLAY command to the item

Returns:



98
99
# File 'lib/openhab/core/items/player_item.rb', line 98

class PlayerItem < GenericItem
end

#play!PlayerItem

Send the PLAY command to the item, even when ensure_states! is in effect.

Returns:



98
99
# File 'lib/openhab/core/items/player_item.rb', line 98

class PlayerItem < GenericItem
end

#play?true, false

Check if the item state == PLAY

Returns:

  • (true, false)


98
99
# File 'lib/openhab/core/items/player_item.rb', line 98

class PlayerItem < GenericItem
end

#previousPlayerItem

Send the PREVIOUS command to the item

Returns:



98
99
# File 'lib/openhab/core/items/player_item.rb', line 98

class PlayerItem < GenericItem
end

#rewindPlayerItem

Send the REWIND command to the item

Returns:



98
99
# File 'lib/openhab/core/items/player_item.rb', line 98

class PlayerItem < GenericItem
end

#rewind!PlayerItem

Send the REWIND command to the item, even when ensure_states! is in effect.

Returns:



98
99
# File 'lib/openhab/core/items/player_item.rb', line 98

class PlayerItem < GenericItem
end

#rewinding?true, false

Check if the item state == REWIND

Returns:

  • (true, false)


98
99
# File 'lib/openhab/core/items/player_item.rb', line 98

class PlayerItem < GenericItem
end

#was_fast_forwarding?true, false

Check if #was is FASTFORWARD

Returns:

  • (true, false)


98
99
# File 'lib/openhab/core/items/player_item.rb', line 98

class PlayerItem < GenericItem
end

#was_paused?true, false

Check if #was is PAUSE

Returns:

  • (true, false)


98
99
# File 'lib/openhab/core/items/player_item.rb', line 98

class PlayerItem < GenericItem
end

#was_playing?true, false

Check if #was is PLAY

Returns:

  • (true, false)


98
99
# File 'lib/openhab/core/items/player_item.rb', line 98

class PlayerItem < GenericItem
end

#was_rewinding?true, false

Check if #was is REWIND

Returns:

  • (true, false)


98
99
# File 'lib/openhab/core/items/player_item.rb', line 98

class PlayerItem < GenericItem
end