Skip to content

Commit c690dce

Browse files
Sravani289Sravani289
authored
Merge pull request #2 from FastPix/feature/add-programmatic-support
Feature/add programmatic support
2 parents bd7690d + 92d9e23 commit c690dce

19 files changed

+2628
-796
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
---
2+
name: Bug Report
3+
about: Report an issue related to the FastPix Web Player SDK
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
# Bug Description
10+
Provide a clear and concise description of the issue you encountered with the FastPix Web Player SDK.
11+
12+
---
13+
14+
# Steps to Reproduce
15+
16+
### 1. **SDK Setup**
17+
18+
Install the FastPix Web Player:
19+
20+
```bash
21+
npm install @fastpix/fp-player
22+
```
23+
24+
**ESM (e.g. React, Vite):**
25+
26+
```javascript
27+
import '@fastpix/fp-player';
28+
// Use <fastpix-player> in your JSX/HTML
29+
```
30+
31+
**Or via script tag (CDN / IIFE):**
32+
33+
```html
34+
<script src="https://cdn.jsdelivr.net/npm/@fastpix/fp-player@latest/dist/player.js"></script>
35+
<!-- FastPixPlayer is available globally -->
36+
```
37+
38+
### 2. **Example Code to Reproduce**
39+
40+
Provide a minimal reproducible snippet (HTML + JS or React) that shows the issue. Example:
41+
42+
```html
43+
<fastpix-player
44+
id="player"
45+
playback-id="<PLAYBACK_ID>"
46+
stream-type="on-demand"
47+
></fastpix-player>
48+
```
49+
50+
Or with token (private/DRM):
51+
52+
```html
53+
<fastpix-player
54+
id="player"
55+
playback-id="<PLAYBACK_ID>"
56+
stream-type="on-demand"
57+
token="<PLAYBACK_TOKEN>"
58+
drm-token="<DRM_TOKEN>"
59+
></fastpix-player>
60+
```
61+
62+
Replace with the exact code where the bug occurs.
63+
64+
---
65+
66+
# Expected Behavior
67+
```
68+
<!-- Describe what you expected to happen -->
69+
```
70+
71+
# Actual Behavior
72+
```
73+
<!-- Describe what actually happened -->
74+
```
75+
76+
---
77+
78+
# Environment
79+
80+
- **Player Version**: [e.g., 1.0.11]
81+
- **Browser**: [e.g., Chrome 120, Safari 17.2, Firefox 121]
82+
- **OS**: [e.g., macOS 14, Windows 11, iOS 17]
83+
- **Node/npm**: [e.g., Node 20, npm 10]
84+
- **Framework**: [e.g., React 18, Vue 3, Vanilla JS, Vite]
85+
- **Integration**: [npm package (ESM) / script tag (CDN)]
86+
87+
---
88+
89+
# Logs / Errors / Console Output
90+
```
91+
Paste browser console logs, network errors, or SDK errors here
92+
```
93+
94+
---
95+
96+
# Additional Context
97+
Add any information that might help, such as:
98+
99+
- DRM playback (Widevine / FairPlay)
100+
- Private vs public stream
101+
- Chromecast / casting
102+
- Shoppable video or playlists
103+
- Custom domains or CORS
104+
105+
---
106+
107+
# Screenshots / Screen Recording
108+
If applicable, attach screenshots or a short video demonstrating the issue.

‎.github/ISSUE_TEMPLATE/documentation_issue.md‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
---
2+
name: Documentation Issue
3+
about: Report issues with the FastPix Web Player documentation
4+
title: '[DOCS] '
5+
labels: ['documentation', 'needs-triage']
6+
assignees: ''
7+
---
8+
9+
# Documentation Issue
10+
11+
Thank you for helping improve the FastPix Web Player documentation! Please provide the following information:
12+
13+
## Issue Type
14+
- [ ] Missing documentation
15+
- [ ] Incorrect information
16+
- [ ] Unclear explanation
17+
- [ ] Broken links
18+
- [ ] Outdated content
19+
- [ ] Other: _______________
20+
21+
## Description
22+
**Provide a clear description of the documentation issue:**
23+
24+
<!-- Example: Steps, methods, or code snippets are confusing, incomplete, or incorrect -->
25+
26+
## Current Documentation
27+
**Paste the current content here:**
28+
29+
<!-- Example: Copy the section of the README or docs that is incorrect -->
30+
31+
## Expected Documentation
32+
**How should the documentation look instead?**
33+
34+
```html
35+
<!-- Example: Correct usage for FastPix Web Player -->
36+
37+
<fastpix-player
38+
id="player"
39+
playback-id="<PLAYBACK_ID>"
40+
stream-type="on-demand"
41+
token="<PLAYBACK_TOKEN>"
42+
></fastpix-player>
43+
```
44+
45+
Or with npm/ESM:
46+
47+
```javascript
48+
import '@fastpix/fp-player';
49+
// Use <fastpix-player> in your app
50+
```
51+
52+
## Location
53+
**Where is this issue located?**
54+
55+
- [ ] README.md
56+
- [ ] PLAYLIST_DEVELOPER_GUIDE.md
57+
- [ ] PLAYLIST_GUIDE.md
58+
- [ ] SHOPPABLE_VIDEO_DEVELOPER_GUIDE.md
59+
- [ ] CHANGELOG.md
60+
- [ ] CONTRIBUTING.md
61+
- [ ] API documentation
62+
- [ ] Code examples
63+
- [ ] Other: _______________
64+
65+
**Specific file or section:**
66+
<!-- e.g., README.md line 45 or "DRM Support" section -->
67+
68+
## Impact
69+
**How does this issue affect users?**
70+
71+
- [ ] Blocks new users from getting started
72+
- [ ] Causes confusion for existing users
73+
- [ ] Leads to incorrect implementation
74+
- [ ] Creates support requests
75+
- [ ] Other: _______________
76+
77+
## Proposed Fix
78+
**Suggested correction or updated example:**
79+
80+
<!-- Example: Provide correct code snippet, instructions, or description -->
81+
82+
## Additional Context
83+
Add any other context about the issue here.
84+
85+
## Screenshots
86+
<!-- If applicable, include screenshots of the documentation issue -->
87+
88+
### Related Issues
89+
- GitHub Issues: [Link related issues]
90+
- User Feedback: [Link to complaints or confusion]
91+
92+
### Testing
93+
**How did you discover this issue?**
94+
95+
- [ ] While following the documentation
96+
- [ ] User reported confusion
97+
- [ ] Code didn't work as documented
98+
- [ ] Other: _______________
99+
100+
## Priority
101+
- [ ] Critical (Blocks users from using the player)
102+
- [ ] High (Causes significant confusion)
103+
- [ ] Medium (Minor clarity issue)
104+
- [ ] Low (Cosmetic improvement)
105+
106+
## Checklist
107+
- [ ] Identified the specific documentation issue
108+
- [ ] Provided current and expected content
109+
- [ ] Explained the impact on users
110+
- [ ] Proposed a clear fix
111+
- [ ] Checked if already reported
112+
- [ ] Provided sufficient context
113+
114+
---
115+
116+
**Thank you for helping improve the FastPix Web Player documentation!**

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Feature Description
10+
A clear and concise description of the feature you'd like to see.
11+
12+
## Problem Statement
13+
Is your feature request related to a problem? Please describe.
14+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
15+
16+
## Proposed Solution
17+
Describe the solution you'd like to see implemented.
18+
19+
## Alternatives Considered
20+
Describe any alternative solutions or features you've considered.
21+
22+
## Use Case
23+
Describe a specific use case or scenario where this feature would be helpful.
24+
25+
## Additional Context
26+
Add any other context, mockups, or examples about the feature request here.

‎.github/ISSUE_TEMPLATE/question_support.md‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
---
2+
name: Question/Support
3+
about: Ask questions or get help with the FastPix Web Player
4+
title: '[QUESTION] '
5+
labels: ['question', 'needs-triage']
6+
assignees: ''
7+
---
8+
9+
# Question/Support
10+
11+
Thank you for reaching out! We're here to help you with the FastPix Web Player. To get faster and more accurate help, please provide the following information:
12+
13+
## Question Type
14+
- [ ] How to use a specific feature
15+
- [ ] Integration help
16+
- [ ] Configuration question
17+
- [ ] Performance question
18+
- [ ] Troubleshooting help
19+
- [ ] Other: _______________
20+
21+
## Question
22+
**What would you like to know?**
23+
24+
<!-- Provide a clear and specific question about the Web Player -->
25+
26+
## What You've Tried
27+
**What have you already attempted to solve this?**
28+
29+
```html
30+
<fastpix-player
31+
id="player"
32+
playback-id="YOUR_PLAYBACK_ID"
33+
stream-type="on-demand"
34+
token="YOUR_TOKEN"
35+
></fastpix-player>
36+
```
37+
38+
Or with npm/ESM:
39+
40+
```javascript
41+
import '@fastpix/fp-player';
42+
// Your attempted code here
43+
```
44+
45+
## Current Setup
46+
**Describe your current setup:**
47+
- Framework (React, Vue, vanilla JS, etc.), build tool, how you load the player (npm vs script tag)
48+
49+
## Environment
50+
- **Player Version**: [e.g., 1.0.11]
51+
- **Browser**: [e.g., Chrome 120, Safari 17]
52+
- **OS**: [e.g., macOS 14, Windows 11]
53+
- **Node/npm**: [e.g., Node 20, npm 10]
54+
- **Framework**: [e.g., React 18, Vue 3, Vanilla JS]
55+
- **Integration**: [npm package (ESM) / script tag (CDN)]
56+
57+
## Configuration
58+
**Current player configuration:**
59+
60+
```html
61+
<fastpix-player
62+
playback-id="..."
63+
stream-type="on-demand"
64+
token="..."
65+
drm-token="..."
66+
></fastpix-player>
67+
```
68+
69+
## Expected Outcome
70+
**What are you trying to achieve?**
71+
72+
<!-- Example: Enable DRM, use playlists, Chromecast, shoppable video, custom controls, etc. -->
73+
74+
## Error Messages (if any)
75+
```
76+
<!-- Paste any console errors or unexpected behavior -->
77+
```
78+
79+
## Additional Context
80+
81+
### Use Case
82+
**What are you building?**
83+
- [ ] Web app (React, Vue, etc.)
84+
- [ ] Marketing/landing page
85+
- [ ] Video streaming product
86+
- [ ] Other: _______________
87+
88+
### Timeline
89+
**When do you need this resolved?**
90+
- [ ] ASAP (blocking development)
91+
- [ ] This week
92+
- [ ] This month
93+
- [ ] No rush
94+
95+
### Resources Checked
96+
**What resources have you already checked?**
97+
- [ ] README.md
98+
- [ ] PLAYLIST_DEVELOPER_GUIDE.md
99+
- [ ] SHOPPABLE_VIDEO_DEVELOPER_GUIDE.md
100+
- [ ] Code examples
101+
- [ ] GitHub Issues
102+
- [ ] Other: _______________
103+
104+
## Priority
105+
Please indicate the urgency:
106+
- [ ] Critical (Blocking production deployment)
107+
- [ ] High (Blocking development)
108+
- [ ] Medium (Would like to know soon)
109+
- [ ] Low (Just curious)
110+
111+
## Checklist
112+
Before submitting, please ensure:
113+
- [ ] I have provided a clear question
114+
- [ ] I have described what I've tried
115+
- [ ] I have included my current setup and environment
116+
- [ ] I have checked existing documentation
117+
- [ ] I have provided sufficient context
118+
119+
---
120+
121+
**We'll do our best to help you get unstuck!**
122+
123+
**Helpful Resources:**
124+
- [FastPix Documentation](https://docs.fastpix.io/docs/installation-process)
125+
- [Web Player README](https://github.com/FastPix/web-player-component#readme)
126+
- [GitHub Discussions](https://github.com/FastPix/web-player-component/issues)

0 commit comments

Comments
 (0)