https://github.com/samsung/tizen-tv-webapis
https://github.com/samsung/tizen-tv-webapis
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/samsung/tizen-tv-webapis
- Owner: Samsung
- License: apache-2.0
- Created: 2020-06-05T05:50:15.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-07T10:00:47.000Z (over 3 years ago)
- Last Synced: 2025-04-11T18:24:53.317Z (over 1 year ago)
- Language: JavaScript
- Size: 1.17 MB
- Stars: 27
- Watchers: 7
- Forks: 11
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tizen-tv-webapis
`tizen-tv-webapis` package is for supporting [Samsung TV Product API](https://developer.samsung.com/smarttv/develop/api-references/samsung-product-api-references.html) as `commonjs` style.
Now we are supporting it for Typescript developers.
Please note that, In order to use this pacakge, `@types/tizen-tv-webapis` is required.
## Supported APIs
- [WebApi](https://developer.samsung.com/smarttv/develop/api-references/samsung-product-api-references/webapi-api.html)
- [Adinfo](https://developer.samsung.com/smarttv/develop/api-references/samsung-product-api-references/adinfo-api.html)
- [AppCommon](https://developer.samsung.com/smarttv/develop/api-references/samsung-product-api-references/appcommon-api.html)
- [AVInfo](https://developer.samsung.com/smarttv/develop/api-references/samsung-product-api-references/avinfo-api.html)
- [AVPlay](https://developer.samsung.com/smarttv/develop/api-references/samsung-product-api-references/avplay-api.html)
- [AVPlayStore](https://developer.samsung.com/smarttv/develop/api-references/samsung-product-api-references/avplaystore-api.html)
- [Billing](https://developer.samsung.com/smarttv/develop/api-references/samsung-product-api-references/billing-api.html)
- [Network](https://developer.samsung.com/smarttv/develop/api-references/samsung-product-api-references/network-api.html)
- [ProductInfo](https://developer.samsung.com/smarttv/develop/api-references/samsung-product-api-references/productinfo-api.html)
- [Sso](https://developer.samsung.com/smarttv/develop/api-references/samsung-product-api-references/sso-api.html)
- [TvInfo](https://developer.samsung.com/smarttv/develop/api-references/samsung-product-api-references/tvinfo-api.html)
- [WidgetData](https://developer.samsung.com/smarttv/develop/api-references/samsung-product-api-references/widgetdata-api.html)
## How to use
- Common js
```sh
npm install tizen-tv-webapis
```
```html
```
```js
// js
const avinfo = require('tizen-tv-webapis');
const { getVersion, getDolbyDigitalCompMode, isHdrTvSupport } = avinfo;
getVersion();
```
- Typescript
```sh
npm install tizen-tv-webapis
npm install @types/tizen-tv-webapis
```
```html
```
```ts
// ts
import { avinfo } from 'tizen-tv-webapis';
const { getVersion, getDolbyDigitalCompMode, isHdrTvSupport } = avinfo;
getVersion();
```
## Enum usage
### v1.0.0
Modules were separated. Enums must have been imported from the each modules.
```ts
import {
setScreenSaver,
AppCommonScreenSaverState
} from 'tizen-tv-webapis/appcommon';
setScreenSaver(AppCommonScreenSaverState.SCREEN_SAVER_ON);
```
### v2.0.0
Modules have been integrated in index.d.ts. Enums can be simply imported from the 'tizen-tv-webapis'.
```ts
import { appcommon, AppCommonScreenSaverState } from 'tizen-tv-webapis';
const { setScreenSaver } = appcommon;
setScreenSaver(AppCommonScreenSaverState.SCREEN_SAVER_ON);
```
## Samples
We offer two samples for common js and typescript.
### Common js (webpack + babel-loader)
- Path : `/samples/commonjs`
- How to Run
1. Move to the path
2. npm install
3. npm run wits-init (To use WITs **Live reload feature**)
4. npm run start
### typescript (webpack + ts-loader)
- Path : `/samples/typescript`
- How to Run
1. Move to the path
2. npm install
3. npm run wits-init (To use WITs **Live reload feature**)
4. npm run start
```
```