Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
pvr_general.h File Reference
#include "../inputstream/stream_constants.h"
#include "pvr_defines.h"
#include <stdbool.h>
#include <stdint.h>

Classes

struct  PVR_ADDON_CAPABILITIES
 "C" PVR add-on capabilities. More...
 
struct  PVR_INT_SETTING_DEFINITION
 "C" Representation of an integer setting definition. More...
 
struct  PVR_STRING_SETTING_DEFINITION
 "C" Representation of a string setting definition. More...
 
struct  PVR_SETTING_DEFINITION
 "C" Representation of a setting definition. More...
 
struct  PVR_SETTING_KEY_VALUE_PAIR
 "C" Representation of a key-value pair, either {int,int} or {int,string}, depending on the type set. More...
 

Macros

#define PVR_STREAM_PROPERTY_STREAMURL   "streamurl"
 the URL of the stream that should be played.
 
#define PVR_STREAM_PROPERTY_INPUTSTREAM   STREAM_PROPERTY_INPUTSTREAM
 To define in stream properties the name of the inputstream add-on that should be used.
 
#define PVR_STREAM_PROPERTY_INPUTSTREAM_PLAYER   STREAM_PROPERTY_INPUTSTREAM_PLAYER
 To define in stream properties the player the inputstream add-on should use.
 
#define PVR_STREAM_PROPERTY_INPUTSTREAM_INSTANCE_ID   STREAM_PROPERTY_INPUTSTREAM_INSTANCE_ID
 Identification string for an input stream.
 
#define PVR_STREAM_PROPERTY_MIMETYPE   "mimetype"
 the MIME type of the stream that should be played.
 
#define PVR_STREAM_PROPERTY_ISREALTIMESTREAM   STREAM_PROPERTY_ISREALTIMESTREAM
 "true" to denote that the stream that should be played is a realtime stream.
 
#define PVR_STREAM_PROPERTY_EPGPLAYBACKASLIVE   "epgplaybackaslive"
 "true" to denote that if the stream is from an EPG tag.
 
#define PVR_STREAM_PROPERTY_LIVEPLAYBACKASEPG   "liveplaybackasepg"
 "true" to denote that if the stream is from a channel but should be played as an EPG tag.
 
#define PVR_STREAM_PROPERTY_VALUE_INPUTSTREAMFFMPEG   STREAM_PROPERTY_VALUE_INPUTSTREAMFFMPEG
 Special value for PVR_STREAM_PROPERTY_INPUTSTREAM to use ffmpeg to directly play a stream URL.
 

Typedefs

typedef enum PVR_ERROR PVR_ERROR
 
typedef enum PVR_CONNECTION_STATE PVR_CONNECTION_STATE
 
typedef enum PVR_SOURCE PVR_SOURCE
 
typedef enum PVR_SETTING_READONLY_CONDITION PVR_SETTING_READONLY_CONDITION
 
typedef enum PVR_SETTING_TYPE PVR_SETTING_TYPE
 
typedef struct PVR_ADDON_CAPABILITIES PVR_ADDON_CAPABILITIES
 "C" PVR add-on capabilities.
 
typedef struct PVR_INT_SETTING_DEFINITION PVR_INT_SETTING_DEFINITION
 "C" Representation of an integer setting definition.
 
typedef struct PVR_STRING_SETTING_DEFINITION PVR_STRING_SETTING_DEFINITION
 "C" Representation of a string setting definition.
 
typedef struct PVR_SETTING_DEFINITION PVR_SETTING_DEFINITION
 "C" Representation of a setting definition.
 
typedef struct PVR_SETTING_KEY_VALUE_PAIR PVR_SETTING_KEY_VALUE_PAIR
 "C" Representation of a key-value pair, either {int,int} or {int,string}, depending on the type set.
 

Enumerations

enum  PVR_ERROR {
  PVR_ERROR_NO_ERROR = 0 , PVR_ERROR_UNKNOWN = -1 , PVR_ERROR_NOT_IMPLEMENTED = -2 , PVR_ERROR_SERVER_ERROR = -3 ,
  PVR_ERROR_SERVER_TIMEOUT = -4 , PVR_ERROR_REJECTED = -5 , PVR_ERROR_ALREADY_PRESENT = -6 , PVR_ERROR_INVALID_PARAMETERS = -7 ,
  PVR_ERROR_RECORDING_RUNNING = -8 , PVR_ERROR_FAILED = -9
}
 
enum  PVR_CONNECTION_STATE {
  PVR_CONNECTION_STATE_UNKNOWN = 0 , PVR_CONNECTION_STATE_SERVER_UNREACHABLE = 1 , PVR_CONNECTION_STATE_SERVER_MISMATCH = 2 , PVR_CONNECTION_STATE_VERSION_MISMATCH = 3 ,
  PVR_CONNECTION_STATE_ACCESS_DENIED = 4 , PVR_CONNECTION_STATE_CONNECTED = 5 , PVR_CONNECTION_STATE_DISCONNECTED = 6 , PVR_CONNECTION_STATE_CONNECTING = 7
}
 
enum  PVR_SOURCE { DEFAULT = 0 , PVR_SOURCE_EPG_AS_LIVE = 1 }
 
enum  PVR_SETTING_READONLY_CONDITION {
  PVR_SETTING_READONLY_CONDITION_NONE = 0 , PVR_SETTING_READONLY_CONDITION_TIMER_DISABLED = (1 << 0) , PVR_SETTING_READONLY_CONDITION_TIMER_SCHEDULED = (1 << 1) , PVR_SETTING_READONLY_CONDITION_TIMER_RECORDING = (1 << 2) ,
  PVR_SETTING_READONLY_CONDITION_TIMER_COMPLETED = (1 << 3)
}
 
enum  PVR_SETTING_TYPE { INTEGER = 0 , STRING = 1 }
 

Typedef Documentation

◆ PVR_ADDON_CAPABILITIES

typedef struct PVR_ADDON_CAPABILITIES PVR_ADDON_CAPABILITIES

"C" PVR add-on capabilities.

Structure used to interface in "C" between Kodi and Addon.

See kodi::addon::PVRCapabilities for description of values.

◆ PVR_INT_SETTING_DEFINITION

typedef struct PVR_INT_SETTING_DEFINITION PVR_INT_SETTING_DEFINITION

"C" Representation of an integer setting definition.

Structure used to interface in "C" between Kodi and Addon.

See kodi::addon::PVRIntSettingDefinition for description of values.

◆ PVR_SETTING_DEFINITION

typedef struct PVR_SETTING_DEFINITION PVR_SETTING_DEFINITION

"C" Representation of a setting definition.

Structure used to interface in "C" between Kodi and Addon.

See kodi::addon::PVRSettingDefinition for description of values.

◆ PVR_SETTING_KEY_VALUE_PAIR

typedef struct PVR_SETTING_KEY_VALUE_PAIR PVR_SETTING_KEY_VALUE_PAIR

"C" Representation of a key-value pair, either {int,int} or {int,string}, depending on the type set.

Structure used to interface in "C" between Kodi and Addon.

See kodi::addon::PVRSettingKeyValuePair for description of values.

◆ PVR_STRING_SETTING_DEFINITION

typedef struct PVR_STRING_SETTING_DEFINITION PVR_STRING_SETTING_DEFINITION

"C" Representation of a string setting definition.

Structure used to interface in "C" between Kodi and Addon.

See kodi::addon::PVRStringSettingDefinition for description of values.